diff --git a/404.html b/404.html index d9f08acdda..634c9c4973 100644 --- a/404.html +++ b/404.html @@ -2,22 +2,24 @@ - + Page Not Found | @open-wa/wa-automate-nodejs + + - - - + + + -
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

\ No newline at end of file diff --git a/assets/css/styles.c43ebbe1.css b/assets/css/styles.c43ebbe1.css new file mode 100644 index 0000000000..0581624a3f --- /dev/null +++ b/assets/css/styles.c43ebbe1.css @@ -0,0 +1 @@ +.col,.container{padding:0 var(--ifm-spacing-horizontal)}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.markdown li,body{word-wrap:break-word}*,.DocSearch-Container,.DocSearch-Container *{box-sizing:border-box}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.authorSocials_rSDt,.authorTitle_nd0D{-webkit-box-orient:vertical;overflow:hidden}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.list_eTzJ article:last-child,.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.items-center,.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width);width:100%}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol,ol ul,ul ol,ul ul{margin:0}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{list-style:none;padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.opacity-80,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.disabled\:pointer-events-none:disabled,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;list-style:none;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.cardContainer_fWXF :last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title,.title_f1Hy{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{list-style:none;margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{content:"";height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.navbar__items--center .navbar__brand,body{margin:0}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.flex,.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{opacity:0;position:fixed;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;bottom:0;visibility:hidden;left:0}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:1rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.inline-flex,.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.bg-background,body{background-color:hsl(var(--background))}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.transition-\[opacity\2c transform\],.transition-colors,.transition-transform{transition-duration:.15s;transition-timing-function:cubic-bezier(.4,0,.2,1)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}*,.border-border{border-color:hsl(var(--border))}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--docsearch-text-color:#f5f6f7;--docsearch-container-background:#090a11cc;--docsearch-modal-background:#15172a;--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309;--docsearch-searchbox-background:#090a11;--docsearch-searchbox-focus-background:#000;--docsearch-hit-color:#bec3c9;--docsearch-hit-shadow:none;--docsearch-hit-background:#090a11;--docsearch-key-gradient:linear-gradient(-26.5deg,#565872,#31355b);--docsearch-key-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 2px 2px 0 #0304094d;--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 1px 1px 0 rgba(3,4,9,.302);--docsearch-footer-background:#1e2136;--docsearch-footer-shadow:inset 0 1px 0 0 #494c6a80,0 -4px 8px 0 #0003;--docsearch-logo-color:#fff;--docsearch-muted-color:#7f8497}:root{--docusaurus-progress-bar-color:var(--ifm-color-primary);--background:0 0% 100%;--foreground:222.2 47.4% 11.2%;--muted:210 40% 96.1%;--muted-foreground:215.4 16.3% 46.9%;--popover:0 0% 100%;--popover-foreground:222.2 47.4% 11.2%;--border:214.3 31.8% 91.4%;--input:214.3 31.8% 91.4%;--card:0 0% 100%;--card-foreground:222.2 47.4% 11.2%;--primary:222.2 47.4% 11.2%;--primary-foreground:210 40% 98%;--secondary:210 40% 96.1%;--secondary-foreground:222.2 47.4% 11.2%;--accent:210 40% 96.1%;--accent-foreground:222.2 47.4% 11.2%;--destructive:0 100% 50%;--destructive-foreground:210 40% 98%;--ring:215 20.2% 65.1%;--radius:0.5rem;--ifm-color-primary:#2e8555;--ifm-color-primary-dark:#29784c;--ifm-color-primary-darker:#277148;--ifm-color-primary-darkest:#205d3b;--ifm-color-primary-light:#33925d;--ifm-color-primary-lighter:#359962;--ifm-color-primary-lightest:#3cad6e;--ifm-code-font-size:95%;--docusaurus-highlighted-code-line-bg:#0000001a;--docsearch-primary-color:#5468ff;--docsearch-text-color:#1c1e21;--docsearch-spacing:12px;--docsearch-icon-stroke-width:1.4;--docsearch-highlight-color:var(--docsearch-primary-color);--docsearch-muted-color:#969faf;--docsearch-container-background:#656c85cc;--docsearch-logo-color:#5468ff;--docsearch-modal-width:560px;--docsearch-modal-height:600px;--docsearch-modal-background:#f5f6f7;--docsearch-modal-shadow:inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64;--docsearch-searchbox-height:56px;--docsearch-searchbox-background:#ebedf0;--docsearch-searchbox-focus-background:#fff;--docsearch-searchbox-shadow:inset 0 0 0 2px var(--docsearch-primary-color);--docsearch-hit-height:56px;--docsearch-hit-color:#444950;--docsearch-hit-active-color:#fff;--docsearch-hit-background:#fff;--docsearch-hit-shadow:0 1px 3px 0 #d4d9e1;--docsearch-key-gradient:linear-gradient(-225deg,#d5dbe4,#f8f8f8);--docsearch-key-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 2px 1px #1e235a66;--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 1px 0 #1e235a66;--docsearch-footer-height:44px;--docsearch-footer-background:#fff;--docsearch-footer-shadow:0 -1px 0 0 #e0e3e8,0 -3px 6px 0 #45629b1f;--docsearch-primary-color:var(--ifm-color-primary);--docsearch-text-color:var(--ifm-font-color-base);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px;--docusaurus-blog-social-icon-size:1rem;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300)}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}.admonition-location .admonition-icon svg{fill:#0000;color:var(--ifm-alert-border-color);stroke-width:2;stroke:currentColor}.admonition-icon svg{transform:scale(.9)}body{color:hsl(var(--foreground));font-feature-settings:"rlig" 1,"calt" 1}*,::backdrop,:after,:before{--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-gradient-from-position: ;--tw-gradient-via-position: ;--tw-gradient-to-position: ;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: ;--tw-contain-size: ;--tw-contain-layout: ;--tw-contain-paint: ;--tw-contain-style: }.container{margin-left:auto;margin-right:auto;padding-left:2rem;padding-right:2rem;width:100%}.fixed{position:fixed}.bottom-0{bottom:0}.left-0{left:0}.right-0{right:0}.z-\[200\]{z-index:200}.m-2{margin:.5rem}.m-auto{margin:auto}.table{display:table}.grid{display:grid}.hidden{display:none}.h-10{height:2.5rem}.h-11{height:2.75rem}.h-14{height:3.5rem}.h-9{height:2.25rem}.h-\[1\.2rem\]{height:1.2rem}.w-10{width:2.5rem}.w-\[1\.2rem\]{width:1.2rem}.w-full{width:100%}.translate-y-0{--tw-translate-y:0px}.translate-y-0,.translate-y-8{transform:translate(var(--tw-translate-x),var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y))}.translate-y-8{--tw-translate-y:2rem}.justify-center,.mdxPageWrapper_j9I6{justify-content:center}.justify-between{justify-content:space-between}.gap-2{gap:.5rem}.whitespace-nowrap{white-space:nowrap}.rounded-md{border-radius:calc(var(--radius) - 2px)}.border{border-width:1px}.border-b{border-bottom-width:1px}.border-t{border-top-width:1px}.border-input{border-color:hsl(var(--input))}.bg-background\/20{background-color:hsl(var(--background)/.2)}.bg-destructive{background-color:hsl(var(--destructive))}.bg-primary{background-color:hsl(var(--primary))}.bg-secondary{background-color:hsl(var(--secondary))}.p-4{padding:1rem}.px-3{padding-left:.75rem;padding-right:.75rem}.px-4{padding-left:1rem;padding-right:1rem}.px-8{padding-left:2rem;padding-right:2rem}.py-2{padding-bottom:.5rem;padding-top:.5rem}.py-5{padding-bottom:1.25rem;padding-top:1.25rem}.text-center{text-align:center}.text-lg{font-size:1.125rem;line-height:1.75rem}.text-sm{font-size:.875rem;line-height:1.25rem}.text-xl{font-size:1.25rem;line-height:1.75rem}.text-xs{font-size:.75rem;line-height:1rem}.font-medium{font-weight:500}.font-normal{font-weight:400}.text-destructive-foreground{color:hsl(var(--destructive-foreground))}.text-primary{color:hsl(var(--primary))}.text-primary-foreground{color:hsl(var(--primary-foreground))}.text-secondary-foreground{color:hsl(var(--secondary-foreground))}.hover\:underline:hover,.underline{text-decoration-line:underline}.underline-offset-4{text-underline-offset:4px}.opacity-0{opacity:0}.footerLogoLink_BH7S:hover,.hash-link:focus,.opacity-100,:hover>.hash-link{opacity:1}.outline{outline-style:solid}.ring-offset-background{--tw-ring-offset-color:hsl(var(--background))}.transition-\[opacity\2c transform\]{transition-property:opacity,transform}.transition-colors{transition-property:color,background-color,border-color,text-decoration-color,fill,stroke}.transition-transform{transition-property:transform}.duration-700{transition-duration:.7s;animation-duration:.7s}[data-theme=dark]{--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#29d5b0;--ifm-color-primary-lighter:#32d8b4;--ifm-color-primary-lightest:#4fddbf;--docusaurus-highlighted-code-line-bg:#0000004d}h3 .label{line-height:20px;margin-left:22px;top:-3px}.label{background:#e0e0e0;border-radius:32px;display:inline-block;font-size:13px;padding:0 12px}.label:hover{background:#ccc}.table-of-contents .label{border-radius:100%;color:#0000;float:none;height:6px;margin-left:4px;margin-top:7px;overflow:hidden;padding:0;position:absolute;white-space:nowrap;width:6px}.label.insiders{background:#a4c936}.label.restricted{background:#ff4500}.navbar-lic-button{background-color:#000!important;border:1px solid #000!important;border-radius:4px!important;color:#fff!important;display:inline-block!important;font-family:Mabry Pro,-apple-system,\.SFNSDisplay-Regular,Helvetica Neue,Helvetica,Arial,sans-serif!important;font-size:16px!important;line-height:1.3!important;padding:8px;text-decoration:none!important;transition:.14s ease-out!important}.menu__list-item>.navbar-lic-button{margin:16px;text-align:center;width:-webkit-fill-available}.hover\:bg-accent:hover{background-color:hsl(var(--accent))}.hover\:bg-destructive\/90:hover{background-color:hsl(var(--destructive)/.9)}.hover\:bg-primary\/90:hover{background-color:hsl(var(--primary)/.9)}.hover\:bg-secondary\/80:hover{background-color:hsl(var(--secondary)/.8)}.hover\:text-accent-foreground:hover{color:hsl(var(--accent-foreground))}.focus-visible\:outline-none:focus-visible{outline:#0000 solid 2px;outline-offset:2px}.focus-visible\:ring-2:focus-visible{--tw-ring-offset-shadow:var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow:var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow,0 0 #0000)}.focus-visible\:ring-ring:focus-visible{--tw-ring-color:hsl(var(--ring))}.focus-visible\:ring-offset-2:focus-visible{--tw-ring-offset-width:2px}.disabled\:opacity-50:disabled{opacity:.5}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}.DocSearch-Button{align-items:center;background:var(--docsearch-searchbox-background);border:0;border-radius:40px;color:var(--docsearch-muted-color);cursor:pointer;display:flex;font-weight:500;height:36px;justify-content:space-between;padding:0 8px;-webkit-user-select:none;user-select:none}.DocSearch-Button:active,.DocSearch-Button:focus,.DocSearch-Button:hover{background:var(--docsearch-searchbox-focus-background);box-shadow:var(--docsearch-searchbox-shadow);color:var(--docsearch-text-color);outline:0}.DocSearch-Button-Container{align-items:center;display:flex}.DocSearch-Search-Icon{stroke-width:1.6}.DocSearch-Hit-Tree,.DocSearch-Hit-action,.DocSearch-Hit-icon,.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Button .DocSearch-Search-Icon{color:var(--docsearch-text-color)}.DocSearch-Button-Placeholder{font-size:1rem;padding:0 12px 0 6px}.DocSearch-Button-Keys{display:flex;min-width:calc(40px + .8em)}.DocSearch-Button-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:3px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 2px;position:relative;top:-1px;width:20px}.DocSearch-Button-Key--pressed{box-shadow:var(--docsearch-key-pressed-shadow);transform:translate3d(0,1px,0)}.DocSearch--active{overflow:hidden!important}.DocSearch-Container{background-color:var(--docsearch-container-background);height:100vh;left:0;position:fixed;top:0;width:100vw;z-index:200}.DocSearch-Container a,.sidebarItemLink_mo7H:hover{text-decoration:none}.DocSearch-Hit[aria-selected=true] mark,.content_knG7 a{text-decoration:underline}.DocSearch-Link{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;font:inherit;margin:0;padding:0}.DocSearch-Modal{background:var(--docsearch-modal-background);border-radius:6px;box-shadow:var(--docsearch-modal-shadow);flex-direction:column;margin:60px auto auto;max-width:var(--docsearch-modal-width);position:relative}.DocSearch-SearchBar{display:flex;padding:var(--docsearch-spacing) var(--docsearch-spacing) 0}.DocSearch-Form{align-items:center;background:var(--docsearch-searchbox-focus-background);border-radius:4px;box-shadow:var(--docsearch-searchbox-shadow);display:flex;height:var(--docsearch-searchbox-height);margin:0;padding:0 var(--docsearch-spacing);position:relative;width:100%}.DocSearch-Input{appearance:none;background:#0000;border:0;color:var(--docsearch-text-color);flex:1;font:inherit;font-size:1.2em;height:100%;outline:0;padding:0 0 0 8px;width:80%}.DocSearch-Input::placeholder{color:var(--docsearch-muted-color);opacity:1}.DocSearch-Input::-webkit-search-cancel-button,.DocSearch-Input::-webkit-search-decoration,.DocSearch-Input::-webkit-search-results-button,.DocSearch-Input::-webkit-search-results-decoration{display:none}.DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{margin:0;padding:0}.DocSearch-Container--Stalled .DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{align-items:center;color:var(--docsearch-highlight-color);display:flex;justify-content:center}.DocSearch-Cancel,.DocSearch-Container--Stalled .DocSearch-MagnifierLabel,.DocSearch-LoadingIndicator,.DocSearch-Reset[hidden]{display:none}.DocSearch-Reset{animation:.1s ease-in forwards a;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;padding:2px;right:0}.DocSearch-Help,.DocSearch-HitsFooter,.DocSearch-Label{color:var(--docsearch-muted-color)}.DocSearch-Reset:hover{color:var(--docsearch-highlight-color)}.DocSearch-LoadingIndicator svg,.DocSearch-MagnifierLabel svg{height:24px;width:24px}.DocSearch-Dropdown{max-height:calc(var(--docsearch-modal-height) - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height));min-height:var(--docsearch-spacing);overflow-y:auto;overflow-y:overlay;padding:0 var(--docsearch-spacing);scrollbar-color:var(--docsearch-muted-color) var(--docsearch-modal-background);scrollbar-width:thin}.sidebar_re4s,.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem)}.DocSearch-Dropdown::-webkit-scrollbar{width:12px}.DocSearch-Dropdown::-webkit-scrollbar-track{background:#0000}.DocSearch-Dropdown::-webkit-scrollbar-thumb{background-color:var(--docsearch-muted-color);border:3px solid var(--docsearch-modal-background);border-radius:20px}.DocSearch-Dropdown ul{list-style:none;margin:0;padding:0}.DocSearch-Label{font-size:.75em;line-height:1.6em}.DocSearch-Help{font-size:.9em;margin:0;-webkit-user-select:none;user-select:none}.DocSearch-Title{font-size:1.2em}.DocSearch-Logo a{display:flex}.DocSearch-Logo svg{color:var(--docsearch-logo-color);margin-left:8px}.DocSearch-Hits:last-of-type{margin-bottom:24px}.DocSearch-Hits mark{background:none;color:var(--docsearch-highlight-color)}.DocSearch-HitsFooter{display:flex;font-size:.85em;justify-content:center;margin-bottom:var(--docsearch-spacing);padding:var(--docsearch-spacing)}.DocSearch-HitsFooter a{border-bottom:1px solid;color:inherit}.DocSearch-Hit{border-radius:4px;display:flex;padding-bottom:4px;position:relative}.DocSearch-Hit--deleting{opacity:0;transition:.25s linear}.DocSearch-Hit--favoriting{transform:scale(0);transform-origin:top center;transition:.25s linear .25s}.DocSearch-Hit a{background:var(--docsearch-hit-background);border-radius:4px;box-shadow:var(--docsearch-hit-shadow);display:block;padding-left:var(--docsearch-spacing);width:100%}.DocSearch-Hit-source{background:var(--docsearch-modal-background);color:var(--docsearch-highlight-color);font-size:.85em;font-weight:600;line-height:32px;margin:0 -4px;padding:8px 4px 0;position:sticky;top:0;z-index:10}.DocSearch-Hit-Tree{color:var(--docsearch-muted-color);height:var(--docsearch-hit-height);opacity:.5;width:24px}.DocSearch-Hit[aria-selected=true] a{background-color:var(--docsearch-highlight-color)}.DocSearch-Hit-Container{align-items:center;color:var(--docsearch-hit-color);display:flex;flex-direction:row;height:var(--docsearch-hit-height);padding:0 var(--docsearch-spacing) 0 0}.DocSearch-Hit-icon{height:20px;width:20px}.DocSearch-Hit-action,.DocSearch-Hit-icon{color:var(--docsearch-muted-color)}.DocSearch-Hit-action{align-items:center;display:flex;height:22px;width:22px}.DocSearch-Hit-action svg{display:block;height:18px;width:18px}.DocSearch-Hit-action+.DocSearch-Hit-action{margin-left:6px}.DocSearch-Hit-action-button{appearance:none;background:none;border:0;border-radius:50%;color:inherit;cursor:pointer;padding:2px}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j,svg.DocSearch-Hit-Select-Icon{display:none}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Select-Icon,.tocCollapsibleContent_vkbj a{display:block}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:background-color .1s ease-in}.DocSearch-Hit-action-button:focus path,.DocSearch-Hit-action-button:hover path{fill:#fff}.DocSearch-Hit-content-wrapper{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;line-height:1.2em;margin:0 8px;overflow-x:hidden;position:relative;text-overflow:ellipsis;white-space:nowrap;width:80%}.DocSearch-Hit-title{font-size:.9em}.DocSearch-Hit-path{color:var(--docsearch-muted-color);font-size:.75em}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Tree,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-action,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-icon,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-path,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-text,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-title,.DocSearch-Hit[aria-selected=true] mark{color:var(--docsearch-hit-active-color)!important}.DocSearch-ErrorScreen,.DocSearch-NoResults,.DocSearch-StartScreen{font-size:.9em;margin:0 auto;padding:36px 0;text-align:center;width:80%}.DocSearch-Screen-Icon{color:var(--docsearch-muted-color);padding-bottom:12px}.DocSearch-NoResults-Prefill-List{display:inline-block;padding-bottom:24px;text-align:left}.DocSearch-NoResults-Prefill-List ul{display:inline-block;padding:8px 0 0}.DocSearch-NoResults-Prefill-List li{list-style-position:inside;list-style-type:"» "}.DocSearch-Prefill{appearance:none;background:none;border:0;border-radius:1em;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;font-size:1em;font-weight:700;padding:0}.DocSearch-Prefill:focus,.DocSearch-Prefill:hover{outline:0;text-decoration:underline}.DocSearch-Footer{align-items:center;background:var(--docsearch-footer-background);border-radius:0 0 8px 8px;box-shadow:var(--docsearch-footer-shadow);display:flex;flex-direction:row-reverse;flex-shrink:0;height:var(--docsearch-footer-height);justify-content:space-between;padding:0 var(--docsearch-spacing);position:relative;-webkit-user-select:none;user-select:none;width:100%;z-index:300}.DocSearch-Commands li,.DocSearch-Commands-Key{align-items:center;display:flex}.DocSearch-Commands{color:var(--docsearch-muted-color);display:flex;list-style:none;margin:0;padding:0}.DocSearch-Commands li:not(:last-of-type){margin-right:.8em}.DocSearch-Commands-Key{background:var(--docsearch-key-gradient);border:0;border-radius:2px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);height:18px;justify-content:center;margin-right:.4em;padding:0 0 1px;width:20px}.DocSearch-VisuallyHiddenForAccessibility{clip:rect(0 0 0 0);clip-path:inset(50%);height:1px;overflow:hidden;position:absolute;white-space:nowrap;width:1px}@keyframes a{0%{opacity:0}to{opacity:1}}.DocSearch-Button{margin:0;transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.DocSearch-Container,.skipToContent_fXgn{z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.iconExternalLink_nPIU{margin-left:.3rem}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.dropdownNavbarItemMobile_S0Fm{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.sidebar_re4s{overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 2rem)}.sidebarItemTitle_pO2u{font-size:var(--ifm-h3-font-size);font-weight:var(--ifm-font-weight-bold)}.container_mt6G,.sidebarItemList_Yudw{font-size:.9rem}.sidebarItem__DBe{margin-top:.7rem}.sidebarItemLink_mo7H{color:var(--ifm-font-color-base);display:block}.sidebarItemLinkActive_I1ZP{color:var(--ifm-color-primary)!important}.yearGroupHeading_rMGB{margin-bottom:.4rem;margin-top:1.6rem}.yearGroupHeading_QT03{margin:1rem .75rem .5rem}.cardContainer_fWXF{--ifm-link-color:var(--ifm-color-emphasis-800);--ifm-link-hover-color:var(--ifm-color-emphasis-700);--ifm-link-hover-decoration:none;border:1px solid var(--ifm-color-emphasis-200);box-shadow:0 1.5px 3px 0 #00000026;transition:all var(--ifm-transition-fast) ease;transition-property:border,box-shadow}.cardContainer_fWXF:hover{border-color:var(--ifm-color-primary);box-shadow:0 3px 6px 0 #0003}.cardTitle_rnsV{font-size:1.2rem}.cardDescription_PWke{font-size:.8rem}.searchQueryInput_u2C7,.searchVersionInput_m0Ui{background:var(--docsearch-searchbox-focus-background);border:2px solid var(--ifm-toc-border-color);border-radius:var(--ifm-global-radius);color:var(--docsearch-text-color);font:var(--ifm-font-size-base) var(--ifm-font-family-base);margin-bottom:.5rem;padding:.8rem;transition:border var(--ifm-transition-fast) ease;width:100%}.searchQueryInput_u2C7:focus,.searchVersionInput_m0Ui:focus{border-color:var(--docsearch-primary-color);outline:0}.searchQueryInput_u2C7::placeholder{color:var(--docsearch-muted-color)}.searchResultsColumn_JPFH{font-size:.9rem;font-weight:700}.algoliaLogo_rT1R{max-width:150px}.algoliaLogoPathFill_WdUC{fill:var(--ifm-font-color-base)}.searchResultItem_Tv2o{border-bottom:1px solid var(--ifm-toc-border-color);padding:1rem 0}.searchResultItemHeading_KbCB{font-weight:400;margin-bottom:0}.searchResultItemPath_lhe1{color:var(--ifm-color-content-secondary);font-size:.8rem;--ifm-breadcrumb-separator-size-multiplier:1}.searchResultItemSummary_AEaO{font-style:italic;margin:.5rem 0 0}.loadingSpinner_XVxU{animation:1s linear infinite b;border:.4em solid #eee;border-radius:50%;border-top:.4em solid var(--ifm-color-primary);height:3rem;margin:0 auto;width:3rem}@keyframes b{to{transform:rotate(1turn)}}.loader_vvXV{margin-top:2rem}.search-result-match{background:#ffd78e40;color:var(--docsearch-hit-color);padding:.09em 0}.features_t9lD{align-items:center;display:flex;padding:2rem 0;width:100%}.featureSvg_GfXr{height:200px;width:200px}.authorSocialIcon_XYv3,.authorSocialLink_owbf,.authorSocials_rSDt{height:var(--docusaurus-blog-social-icon-size)}.authorSocialIcon_XYv3,.authorSocialLink_owbf{width:var(--docusaurus-blog-social-icon-size)}.heroBanner_qdFl{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_AeoN{align-items:center;display:flex;justify-content:center}[data-theme=dark] .githubSvg_Uu4N,[data-theme=dark] .xSvg_y3PF{fill:var(--light)}[data-theme=light] .githubSvg_Uu4N,[data-theme=light] .xSvg_y3PF{fill:var(--dark)}.authorSocials_rSDt{align-items:center;display:flex;flex-wrap:wrap;line-clamp:1;-webkit-line-clamp:1}.authorSocialLink_owbf,.authorSocials_rSDt{line-height:0}.authorSocialLink_owbf{margin-right:.4rem}.authorImage_XqGP{--ifm-avatar-photo-size:3.6rem}.author-as-h1_n9oJ .authorImage_XqGP{--ifm-avatar-photo-size:7rem}.author-as-h2_gXvM .authorImage_XqGP{--ifm-avatar-photo-size:5.4rem}.authorDetails_lV9A{align-items:flex-start;display:flex;flex-direction:column;justify-content:space-around}.authorName_yefp{display:flex;flex-direction:row;font-size:1.1rem;line-height:1.1rem}.author-as-h1_n9oJ .authorName_yefp{display:inline;font-size:2.4rem;line-height:2.4rem}.author-as-h2_gXvM .authorName_yefp{display:inline;font-size:1.4rem;line-height:1.4rem}.authorTitle_nd0D{display:-webkit-box;font-size:.8rem;line-height:1rem;line-clamp:1;-webkit-line-clamp:1}.author-as-h1_n9oJ .authorTitle_nd0D{font-size:1.2rem;line-height:1.6rem}.author-as-h2_gXvM .authorTitle_nd0D{font-size:1rem;line-height:1.3rem}.authorBlogPostCount_iiJ5{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.8rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.authorListItem_n3yI{list-style-type:none;margin-bottom:2rem}.authorCol_Hf19{max-width:inherit!important}.imageOnlyAuthorRow_pa_O{display:flex;flex-flow:row wrap}.imageOnlyAuthorCol_G86a{margin-left:.3rem;margin-right:.3rem}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{left:0;position:absolute;top:0;fill:currentColor;height:inherit;opacity:inherit;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tag_Nnez{display:inline-block;margin:.5rem .5rem 0 1rem}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;list-style:none;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.containsTaskList_mC6p{list-style:none}.img_ev3q{height:auto}.tableOfContents_bqdL{overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;height:1.6em;width:1.6em;fill:var(--ifm-alert-foreground-color)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.title_kItE{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-leading)*1.25)}@media (min-width:640px){.sm\:bottom-4{bottom:1rem}.sm\:left-4{left:1rem}.sm\:max-w-md{max-width:28rem}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn,.generatedIndexPage_vN6x{max-width:75%!important}.list_eTzJ article:nth-last-child(-n+2){margin-bottom:0!important}}@media (min-width:1400px){.container{max-width:1400px}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.sidebar_re4s,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media only screen and (max-width:996px){.searchQueryColumn_RTkw,.searchResultsColumn_JPFH{max-width:60%!important}.searchLogoColumn_rJIA,.searchVersionColumn_ypXd{max-width:40%!important}.searchLogoColumn_rJIA{padding-left:0!important}}@media screen and (max-width:996px){.heroBanner_qdFl{padding:2rem}}@media (max-width:768px){.DocSearch-Button-Keys,.DocSearch-Button-Placeholder,.DocSearch-Commands,.DocSearch-Hit-Tree{display:none}:root{--docsearch-spacing:10px;--docsearch-footer-height:40px}.DocSearch-Dropdown{height:100%;max-height:calc(var(--docsearch-vh,1vh)*100 - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height))}.DocSearch-Container{height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);position:absolute}.DocSearch-Footer{border-radius:0;bottom:0;position:absolute}.DocSearch-Hit-content-wrapper{display:flex;position:relative;width:80%}.DocSearch-Modal{border-radius:0;box-shadow:none;height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);margin:0;max-width:100%;width:100%}.DocSearch-Cancel{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;flex:none;font:inherit;font-size:1em;font-weight:500;margin-left:var(--docsearch-spacing);outline:0;overflow:hidden;padding:0;-webkit-user-select:none;user-select:none;white-space:nowrap}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}.title_f1Hy{font-size:2rem}}@media screen and (max-width:576px){.searchQueryColumn_RTkw{max-width:100%!important}.searchVersionColumn_ypXd{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media screen and (prefers-reduced-motion:reduce){.DocSearch-Reset{animation:none;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;right:0;stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Hit--deleting,.DocSearch-Hit--favoriting{transition:none}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:none}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/css/styles.fcbf9245.css b/assets/css/styles.fcbf9245.css deleted file mode 100644 index 49d43be7ef..0000000000 --- a/assets/css/styles.fcbf9245.css +++ /dev/null @@ -1 +0,0 @@ -.col,.container{padding:0 var(--ifm-spacing-horizontal)}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.markdown li,body{word-wrap:break-word}*,.DocSearch-Container,.DocSearch-Container *{box-sizing:border-box}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.list_eTzJ article:last-child,.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.items-center,.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width);width:100%}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol,ol ul,ul ol,ul ul{margin:0}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{list-style:none;padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.opacity-80,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.disabled\:pointer-events-none:disabled,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;list-style:none;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.cardContainer_fWXF :last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title,.title_f1Hy{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{list-style:none;margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{content:"";height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.navbar__items--center .navbar__brand,body{margin:0}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.flex,.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{opacity:0;position:fixed;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;bottom:0;visibility:hidden;left:0}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.inline-flex,.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.bg-background,body{background-color:hsl(var(--background))}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.transition-\[opacity\2c transform\],.transition-colors,.transition-transform{transition-duration:.15s;transition-timing-function:cubic-bezier(.4,0,.2,1)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}*,.border-border{border-color:hsl(var(--border))}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--docsearch-text-color:#f5f6f7;--docsearch-container-background:#090a11cc;--docsearch-modal-background:#15172a;--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309;--docsearch-searchbox-background:#090a11;--docsearch-searchbox-focus-background:#000;--docsearch-hit-color:#bec3c9;--docsearch-hit-shadow:none;--docsearch-hit-background:#090a11;--docsearch-key-gradient:linear-gradient(-26.5deg,#565872,#31355b);--docsearch-key-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 2px 2px 0 #0304094d;--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 1px 1px 0 rgba(3,4,9,.302);--docsearch-footer-background:#1e2136;--docsearch-footer-shadow:inset 0 1px 0 0 #494c6a80,0 -4px 8px 0 #0003;--docsearch-logo-color:#fff;--docsearch-muted-color:#7f8497}:root{--docusaurus-progress-bar-color:var(--ifm-color-primary);--background:0 0% 100%;--foreground:222.2 47.4% 11.2%;--muted:210 40% 96.1%;--muted-foreground:215.4 16.3% 46.9%;--popover:0 0% 100%;--popover-foreground:222.2 47.4% 11.2%;--border:214.3 31.8% 91.4%;--input:214.3 31.8% 91.4%;--card:0 0% 100%;--card-foreground:222.2 47.4% 11.2%;--primary:222.2 47.4% 11.2%;--primary-foreground:210 40% 98%;--secondary:210 40% 96.1%;--secondary-foreground:222.2 47.4% 11.2%;--accent:210 40% 96.1%;--accent-foreground:222.2 47.4% 11.2%;--destructive:0 100% 50%;--destructive-foreground:210 40% 98%;--ring:215 20.2% 65.1%;--radius:0.5rem;--ifm-color-primary:#2e8555;--ifm-color-primary-dark:#29784c;--ifm-color-primary-darker:#277148;--ifm-color-primary-darkest:#205d3b;--ifm-color-primary-light:#33925d;--ifm-color-primary-lighter:#359962;--ifm-color-primary-lightest:#3cad6e;--ifm-code-font-size:95%;--docusaurus-highlighted-code-line-bg:#0000001a;--docsearch-primary-color:#5468ff;--docsearch-text-color:#1c1e21;--docsearch-spacing:12px;--docsearch-icon-stroke-width:1.4;--docsearch-highlight-color:var(--docsearch-primary-color);--docsearch-muted-color:#969faf;--docsearch-container-background:#656c85cc;--docsearch-logo-color:#5468ff;--docsearch-modal-width:560px;--docsearch-modal-height:600px;--docsearch-modal-background:#f5f6f7;--docsearch-modal-shadow:inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64;--docsearch-searchbox-height:56px;--docsearch-searchbox-background:#ebedf0;--docsearch-searchbox-focus-background:#fff;--docsearch-searchbox-shadow:inset 0 0 0 2px var(--docsearch-primary-color);--docsearch-hit-height:56px;--docsearch-hit-color:#444950;--docsearch-hit-active-color:#fff;--docsearch-hit-background:#fff;--docsearch-hit-shadow:0 1px 3px 0 #d4d9e1;--docsearch-key-gradient:linear-gradient(-225deg,#d5dbe4,#f8f8f8);--docsearch-key-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 2px 1px #1e235a66;--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 1px 0 #1e235a66;--docsearch-footer-height:44px;--docsearch-footer-background:#fff;--docsearch-footer-shadow:0 -1px 0 0 #e0e3e8,0 -3px 6px 0 #45629b1f;--docsearch-primary-color:var(--ifm-color-primary);--docsearch-text-color:var(--ifm-font-color-base);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300)}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}.admonition-location .admonition-icon svg{fill:#0000;color:var(--ifm-alert-border-color);stroke-width:2;stroke:currentColor}.admonition-icon svg{transform:scale(.9)}body{color:hsl(var(--foreground));font-feature-settings:"rlig" 1,"calt" 1}*,::backdrop,:after,:before{--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-gradient-from-position: ;--tw-gradient-via-position: ;--tw-gradient-to-position: ;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: ;--tw-contain-size: ;--tw-contain-layout: ;--tw-contain-paint: ;--tw-contain-style: }.container{margin-left:auto;margin-right:auto;padding-left:2rem;padding-right:2rem;width:100%}.fixed{position:fixed}.bottom-0{bottom:0}.left-0{left:0}.right-0{right:0}.z-\[200\]{z-index:200}.m-2{margin:.5rem}.m-auto{margin:auto}.table{display:table}.grid{display:grid}.hidden{display:none}.h-10{height:2.5rem}.h-11{height:2.75rem}.h-14{height:3.5rem}.h-9{height:2.25rem}.h-\[1\.2rem\]{height:1.2rem}.w-10{width:2.5rem}.w-\[1\.2rem\]{width:1.2rem}.w-full{width:100%}.translate-y-0{--tw-translate-y:0px}.translate-y-0,.translate-y-8{transform:translate(var(--tw-translate-x),var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y))}.translate-y-8{--tw-translate-y:2rem}.justify-center,.mdxPageWrapper_j9I6{justify-content:center}.justify-between{justify-content:space-between}.gap-2{gap:.5rem}.whitespace-nowrap{white-space:nowrap}.rounded-md{border-radius:calc(var(--radius) - 2px)}.border{border-width:1px}.border-b{border-bottom-width:1px}.border-t{border-top-width:1px}.border-input{border-color:hsl(var(--input))}.bg-background\/20{background-color:hsl(var(--background)/.2)}.bg-destructive{background-color:hsl(var(--destructive))}.bg-primary{background-color:hsl(var(--primary))}.bg-secondary{background-color:hsl(var(--secondary))}.p-4{padding:1rem}.px-3{padding-left:.75rem;padding-right:.75rem}.px-4{padding-left:1rem;padding-right:1rem}.px-8{padding-left:2rem;padding-right:2rem}.py-2{padding-bottom:.5rem;padding-top:.5rem}.py-5{padding-bottom:1.25rem;padding-top:1.25rem}.text-center{text-align:center}.text-lg{font-size:1.125rem;line-height:1.75rem}.text-sm{font-size:.875rem;line-height:1.25rem}.text-xl{font-size:1.25rem;line-height:1.75rem}.text-xs{font-size:.75rem;line-height:1rem}.font-medium{font-weight:500}.font-normal{font-weight:400}.text-destructive-foreground{color:hsl(var(--destructive-foreground))}.text-primary{color:hsl(var(--primary))}.text-primary-foreground{color:hsl(var(--primary-foreground))}.text-secondary-foreground{color:hsl(var(--secondary-foreground))}.hover\:underline:hover,.underline{text-decoration-line:underline}.underline-offset-4{text-underline-offset:4px}.opacity-0{opacity:0}.footerLogoLink_BH7S:hover,.hash-link:focus,.opacity-100,:hover>.hash-link{opacity:1}.outline{outline-style:solid}.ring-offset-background{--tw-ring-offset-color:hsl(var(--background))}.transition-\[opacity\2c transform\]{transition-property:opacity,transform}.transition-colors{transition-property:color,background-color,border-color,text-decoration-color,fill,stroke}.transition-transform{transition-property:transform}.duration-700{transition-duration:.7s;animation-duration:.7s}[data-theme=dark]{--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#29d5b0;--ifm-color-primary-lighter:#32d8b4;--ifm-color-primary-lightest:#4fddbf;--docusaurus-highlighted-code-line-bg:#0000004d}h3 .label{line-height:20px;margin-left:22px;top:-3px}.label{background:#e0e0e0;border-radius:32px;display:inline-block;font-size:13px;padding:0 12px}.label:hover{background:#ccc}.table-of-contents .label{border-radius:100%;color:#0000;float:none;height:6px;margin-left:4px;margin-top:7px;overflow:hidden;padding:0;position:absolute;white-space:nowrap;width:6px}.label.insiders{background:#a4c936}.label.restricted{background:#ff4500}.navbar-lic-button{background-color:#000!important;border:1px solid #000!important;border-radius:4px!important;color:#fff!important;display:inline-block!important;font-family:Mabry Pro,-apple-system,\.SFNSDisplay-Regular,Helvetica Neue,Helvetica,Arial,sans-serif!important;font-size:16px!important;line-height:1.3!important;padding:8px;text-decoration:none!important;transition:.14s ease-out!important}.menu__list-item>.navbar-lic-button{margin:16px;text-align:center;width:-webkit-fill-available}.hover\:bg-accent:hover{background-color:hsl(var(--accent))}.hover\:bg-destructive\/90:hover{background-color:hsl(var(--destructive)/.9)}.hover\:bg-primary\/90:hover{background-color:hsl(var(--primary)/.9)}.hover\:bg-secondary\/80:hover{background-color:hsl(var(--secondary)/.8)}.hover\:text-accent-foreground:hover{color:hsl(var(--accent-foreground))}.focus-visible\:outline-none:focus-visible{outline:#0000 solid 2px;outline-offset:2px}.focus-visible\:ring-2:focus-visible{--tw-ring-offset-shadow:var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow:var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow,0 0 #0000)}.focus-visible\:ring-ring:focus-visible{--tw-ring-color:hsl(var(--ring))}.focus-visible\:ring-offset-2:focus-visible{--tw-ring-offset-width:2px}.disabled\:opacity-50:disabled{opacity:.5}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}.DocSearch-Button{align-items:center;background:var(--docsearch-searchbox-background);border:0;border-radius:40px;color:var(--docsearch-muted-color);cursor:pointer;display:flex;font-weight:500;height:36px;justify-content:space-between;padding:0 8px;-webkit-user-select:none;user-select:none}.DocSearch-Button:active,.DocSearch-Button:focus,.DocSearch-Button:hover{background:var(--docsearch-searchbox-focus-background);box-shadow:var(--docsearch-searchbox-shadow);color:var(--docsearch-text-color);outline:0}.DocSearch-Button-Container{align-items:center;display:flex}.DocSearch-Search-Icon{stroke-width:1.6}.DocSearch-Hit-Tree,.DocSearch-Hit-action,.DocSearch-Hit-icon,.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Button .DocSearch-Search-Icon{color:var(--docsearch-text-color)}.DocSearch-Button-Placeholder{font-size:1rem;padding:0 12px 0 6px}.DocSearch-Button-Keys{display:flex;min-width:calc(40px + .8em)}.DocSearch-Button-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:3px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 2px;position:relative;top:-1px;width:20px}.DocSearch-Button-Key--pressed{box-shadow:var(--docsearch-key-pressed-shadow);transform:translate3d(0,1px,0)}.DocSearch--active{overflow:hidden!important}.DocSearch-Container{background-color:var(--docsearch-container-background);height:100vh;left:0;position:fixed;top:0;width:100vw;z-index:200}.DocSearch-Container a,.sidebarItemLink_mo7H:hover{text-decoration:none}.DocSearch-Hit[aria-selected=true] mark,.content_knG7 a{text-decoration:underline}.DocSearch-Link{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;font:inherit;margin:0;padding:0}.DocSearch-Modal{background:var(--docsearch-modal-background);border-radius:6px;box-shadow:var(--docsearch-modal-shadow);flex-direction:column;margin:60px auto auto;max-width:var(--docsearch-modal-width);position:relative}.DocSearch-SearchBar{display:flex;padding:var(--docsearch-spacing) var(--docsearch-spacing) 0}.DocSearch-Form{align-items:center;background:var(--docsearch-searchbox-focus-background);border-radius:4px;box-shadow:var(--docsearch-searchbox-shadow);display:flex;height:var(--docsearch-searchbox-height);margin:0;padding:0 var(--docsearch-spacing);position:relative;width:100%}.DocSearch-Input{appearance:none;background:#0000;border:0;color:var(--docsearch-text-color);flex:1;font:inherit;font-size:1.2em;height:100%;outline:0;padding:0 0 0 8px;width:80%}.DocSearch-Input::placeholder{color:var(--docsearch-muted-color);opacity:1}.DocSearch-Input::-webkit-search-cancel-button,.DocSearch-Input::-webkit-search-decoration,.DocSearch-Input::-webkit-search-results-button,.DocSearch-Input::-webkit-search-results-decoration{display:none}.DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{margin:0;padding:0}.DocSearch-Container--Stalled .DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{align-items:center;color:var(--docsearch-highlight-color);display:flex;justify-content:center}.DocSearch-Cancel,.DocSearch-Container--Stalled .DocSearch-MagnifierLabel,.DocSearch-LoadingIndicator,.DocSearch-Reset[hidden]{display:none}.DocSearch-Reset{animation:.1s ease-in forwards a;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;padding:2px;right:0}.DocSearch-Help,.DocSearch-HitsFooter,.DocSearch-Label{color:var(--docsearch-muted-color)}.DocSearch-Reset:hover{color:var(--docsearch-highlight-color)}.DocSearch-LoadingIndicator svg,.DocSearch-MagnifierLabel svg{height:24px;width:24px}.DocSearch-Dropdown{max-height:calc(var(--docsearch-modal-height) - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height));min-height:var(--docsearch-spacing);overflow-y:auto;overflow-y:overlay;padding:0 var(--docsearch-spacing);scrollbar-color:var(--docsearch-muted-color) var(--docsearch-modal-background);scrollbar-width:thin}.sidebar_re4s,.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem)}.DocSearch-Dropdown::-webkit-scrollbar{width:12px}.DocSearch-Dropdown::-webkit-scrollbar-track{background:#0000}.DocSearch-Dropdown::-webkit-scrollbar-thumb{background-color:var(--docsearch-muted-color);border:3px solid var(--docsearch-modal-background);border-radius:20px}.DocSearch-Dropdown ul{list-style:none;margin:0;padding:0}.DocSearch-Label{font-size:.75em;line-height:1.6em}.DocSearch-Help{font-size:.9em;margin:0;-webkit-user-select:none;user-select:none}.DocSearch-Title{font-size:1.2em}.DocSearch-Logo a{display:flex}.DocSearch-Logo svg{color:var(--docsearch-logo-color);margin-left:8px}.DocSearch-Hits:last-of-type{margin-bottom:24px}.DocSearch-Hits mark{background:none;color:var(--docsearch-highlight-color)}.DocSearch-HitsFooter{display:flex;font-size:.85em;justify-content:center;margin-bottom:var(--docsearch-spacing);padding:var(--docsearch-spacing)}.DocSearch-HitsFooter a{border-bottom:1px solid;color:inherit}.DocSearch-Hit{border-radius:4px;display:flex;padding-bottom:4px;position:relative}.DocSearch-Hit--deleting{opacity:0;transition:.25s linear}.DocSearch-Hit--favoriting{transform:scale(0);transform-origin:top center;transition:.25s linear .25s}.DocSearch-Hit a{background:var(--docsearch-hit-background);border-radius:4px;box-shadow:var(--docsearch-hit-shadow);display:block;padding-left:var(--docsearch-spacing);width:100%}.DocSearch-Hit-source{background:var(--docsearch-modal-background);color:var(--docsearch-highlight-color);font-size:.85em;font-weight:600;line-height:32px;margin:0 -4px;padding:8px 4px 0;position:sticky;top:0;z-index:10}.DocSearch-Hit-Tree{color:var(--docsearch-muted-color);height:var(--docsearch-hit-height);opacity:.5;width:24px}.DocSearch-Hit[aria-selected=true] a{background-color:var(--docsearch-highlight-color)}.DocSearch-Hit-Container{align-items:center;color:var(--docsearch-hit-color);display:flex;flex-direction:row;height:var(--docsearch-hit-height);padding:0 var(--docsearch-spacing) 0 0}.DocSearch-Hit-icon{height:20px;width:20px}.DocSearch-Hit-action,.DocSearch-Hit-icon{color:var(--docsearch-muted-color)}.DocSearch-Hit-action{align-items:center;display:flex;height:22px;width:22px}.DocSearch-Hit-action svg{display:block;height:18px;width:18px}.DocSearch-Hit-action+.DocSearch-Hit-action{margin-left:6px}.DocSearch-Hit-action-button{appearance:none;background:none;border:0;border-radius:50%;color:inherit;cursor:pointer;padding:2px}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j,svg.DocSearch-Hit-Select-Icon{display:none}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Select-Icon,.tocCollapsibleContent_vkbj a{display:block}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:background-color .1s ease-in}.DocSearch-Hit-action-button:focus path,.DocSearch-Hit-action-button:hover path{fill:#fff}.DocSearch-Hit-content-wrapper{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;line-height:1.2em;margin:0 8px;overflow-x:hidden;position:relative;text-overflow:ellipsis;white-space:nowrap;width:80%}.DocSearch-Hit-title{font-size:.9em}.DocSearch-Hit-path{color:var(--docsearch-muted-color);font-size:.75em}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Tree,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-action,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-icon,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-path,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-text,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-title,.DocSearch-Hit[aria-selected=true] mark{color:var(--docsearch-hit-active-color)!important}.DocSearch-ErrorScreen,.DocSearch-NoResults,.DocSearch-StartScreen{font-size:.9em;margin:0 auto;padding:36px 0;text-align:center;width:80%}.DocSearch-Screen-Icon{color:var(--docsearch-muted-color);padding-bottom:12px}.DocSearch-NoResults-Prefill-List{display:inline-block;padding-bottom:24px;text-align:left}.DocSearch-NoResults-Prefill-List ul{display:inline-block;padding:8px 0 0}.DocSearch-NoResults-Prefill-List li{list-style-position:inside;list-style-type:"» "}.DocSearch-Prefill{appearance:none;background:none;border:0;border-radius:1em;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;font-size:1em;font-weight:700;padding:0}.DocSearch-Prefill:focus,.DocSearch-Prefill:hover{outline:0;text-decoration:underline}.DocSearch-Footer{align-items:center;background:var(--docsearch-footer-background);border-radius:0 0 8px 8px;box-shadow:var(--docsearch-footer-shadow);display:flex;flex-direction:row-reverse;flex-shrink:0;height:var(--docsearch-footer-height);justify-content:space-between;padding:0 var(--docsearch-spacing);position:relative;-webkit-user-select:none;user-select:none;width:100%;z-index:300}.DocSearch-Commands li,.DocSearch-Commands-Key{align-items:center;display:flex}.DocSearch-Commands{color:var(--docsearch-muted-color);display:flex;list-style:none;margin:0;padding:0}.DocSearch-Commands li:not(:last-of-type){margin-right:.8em}.DocSearch-Commands-Key{background:var(--docsearch-key-gradient);border:0;border-radius:2px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);height:18px;justify-content:center;margin-right:.4em;padding:0 0 1px;width:20px}.DocSearch-VisuallyHiddenForAccessibility{clip:rect(0 0 0 0);clip-path:inset(50%);height:1px;overflow:hidden;position:absolute;white-space:nowrap;width:1px}@keyframes a{0%{opacity:0}to{opacity:1}}.DocSearch-Button{margin:0;transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.DocSearch-Container,.skipToContent_fXgn{z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.iconExternalLink_nPIU{margin-left:.3rem}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.dropdownNavbarItemMobile_S0Fm{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.sidebar_re4s{overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 2rem)}.sidebarItemTitle_pO2u{font-size:var(--ifm-h3-font-size);font-weight:var(--ifm-font-weight-bold)}.container_mt6G,.sidebarItemList_Yudw{font-size:.9rem}.sidebarItem__DBe{margin-top:.7rem}.sidebarItemLink_mo7H{color:var(--ifm-font-color-base);display:block}.sidebarItemLinkActive_I1ZP{color:var(--ifm-color-primary)!important}.cardContainer_fWXF{--ifm-link-color:var(--ifm-color-emphasis-800);--ifm-link-hover-color:var(--ifm-color-emphasis-700);--ifm-link-hover-decoration:none;border:1px solid var(--ifm-color-emphasis-200);box-shadow:0 1.5px 3px 0 #00000026;transition:all var(--ifm-transition-fast) ease;transition-property:border,box-shadow}.cardContainer_fWXF:hover{border-color:var(--ifm-color-primary);box-shadow:0 3px 6px 0 #0003}.cardTitle_rnsV{font-size:1.2rem}.cardDescription_PWke{font-size:.8rem}.searchQueryInput_u2C7,.searchVersionInput_m0Ui{background:var(--docsearch-searchbox-focus-background);border:2px solid var(--ifm-toc-border-color);border-radius:var(--ifm-global-radius);color:var(--docsearch-text-color);font:var(--ifm-font-size-base) var(--ifm-font-family-base);margin-bottom:.5rem;padding:.8rem;transition:border var(--ifm-transition-fast) ease;width:100%}.searchQueryInput_u2C7:focus,.searchVersionInput_m0Ui:focus{border-color:var(--docsearch-primary-color);outline:0}.searchQueryInput_u2C7::placeholder{color:var(--docsearch-muted-color)}.searchResultsColumn_JPFH{font-size:.9rem;font-weight:700}.algoliaLogo_rT1R{max-width:150px}.algoliaLogoPathFill_WdUC{fill:var(--ifm-font-color-base)}.searchResultItem_Tv2o{border-bottom:1px solid var(--ifm-toc-border-color);padding:1rem 0}.searchResultItemHeading_KbCB{font-weight:400;margin-bottom:0}.searchResultItemPath_lhe1{color:var(--ifm-color-content-secondary);font-size:.8rem;--ifm-breadcrumb-separator-size-multiplier:1}.searchResultItemSummary_AEaO{font-style:italic;margin:.5rem 0 0}.loadingSpinner_XVxU{animation:1s linear infinite b;border:.4em solid #eee;border-radius:50%;border-top:.4em solid var(--ifm-color-primary);height:3rem;margin:0 auto;width:3rem}@keyframes b{to{transform:rotate(1turn)}}.loader_vvXV{margin-top:2rem}.search-result-match{background:#ffd78e40;color:var(--docsearch-hit-color);padding:.09em 0}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.features_t9lD{align-items:center;display:flex;padding:2rem 0;width:100%}.featureSvg_GfXr{height:200px;width:200px}.heroBanner_qdFl{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_AeoN{align-items:center;display:flex;justify-content:center}.authorCol_Hf19{flex-grow:1!important;max-width:inherit!important}.imageOnlyAuthorRow_pa_O{display:flex;flex-flow:row wrap}.imageOnlyAuthorCol_G86a{margin-left:.3rem;margin-right:.3rem}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{left:0;position:absolute;top:0;fill:currentColor;height:inherit;opacity:inherit;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tag_Nnez{display:inline-block;margin:.5rem .5rem 0 1rem}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;list-style:none;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.containsTaskList_mC6p{list-style:none}.img_ev3q{height:auto}.tableOfContents_bqdL{overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;height:1.6em;width:1.6em;fill:var(--ifm-alert-foreground-color)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.title_kItE{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-leading)*1.25)}@media (min-width:640px){.sm\:bottom-4{bottom:1rem}.sm\:left-4{left:1rem}.sm\:max-w-md{max-width:28rem}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn,.generatedIndexPage_vN6x{max-width:75%!important}.list_eTzJ article:nth-last-child(-n+2){margin-bottom:0!important}}@media (min-width:1400px){.container{max-width:1400px}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.sidebar_re4s,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media only screen and (max-width:996px){.searchQueryColumn_RTkw,.searchResultsColumn_JPFH{max-width:60%!important}.searchLogoColumn_rJIA,.searchVersionColumn_ypXd{max-width:40%!important}.searchLogoColumn_rJIA{padding-left:0!important}}@media screen and (max-width:996px){.heroBanner_qdFl{padding:2rem}}@media (max-width:768px){.DocSearch-Button-Keys,.DocSearch-Button-Placeholder,.DocSearch-Commands,.DocSearch-Hit-Tree{display:none}:root{--docsearch-spacing:10px;--docsearch-footer-height:40px}.DocSearch-Dropdown{height:100%;max-height:calc(var(--docsearch-vh,1vh)*100 - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height))}.DocSearch-Container{height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);position:absolute}.DocSearch-Footer{border-radius:0;bottom:0;position:absolute}.DocSearch-Hit-content-wrapper{display:flex;position:relative;width:80%}.DocSearch-Modal{border-radius:0;box-shadow:none;height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);margin:0;max-width:100%;width:100%}.DocSearch-Cancel{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;flex:none;font:inherit;font-size:1em;font-weight:500;margin-left:var(--docsearch-spacing);outline:0;overflow:hidden;padding:0;-webkit-user-select:none;user-select:none;white-space:nowrap}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}.title_f1Hy{font-size:2rem}}@media screen and (max-width:576px){.searchQueryColumn_RTkw{max-width:100%!important}.searchVersionColumn_ypXd{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media screen and (prefers-reduced-motion:reduce){.DocSearch-Reset{animation:none;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;right:0;stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Hit--deleting,.DocSearch-Hit--favoriting{transition:none}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:none}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/0057296d.1980830c.js b/assets/js/0057296d.1980830c.js new file mode 100644 index 0000000000..d01e998f22 --- /dev/null +++ b/assets/js/0057296d.1980830c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1482],{3667:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(4848),t=n(8453);const i={},r="Sending Messages",d={id:"how-to/send-messages",title:"Sending Messages",description:"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.",source:"@site/docs/how-to/send-messages.md",sourceDirName:"how-to",slug:"/how-to/send-messages",permalink:"/docs/how-to/send-messages",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-messages.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Sending Files",permalink:"/docs/how-to/send-files"},next:{title:"Send Video",permalink:"/docs/how-to/send-videos"}},l={},o=[{value:"Send a basic message",id:"send-a-basic-message",level:2},{value:"Send a message with mentions",id:"send-a-message-with-mentions",level:2},{value:"Send a reply",id:"send-a-reply",level:2},{value:"Send a reply with mentions",id:"send-a-reply-with-mentions",level:2},{value:"Forward Messages",id:"forward-messages",level:2}];function c(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.header,{children:(0,a.jsx)(s.h1,{id:"sending-messages",children:"Sending Messages"})}),"\n",(0,a.jsx)(s.p,{children:"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully."}),"\n",(0,a.jsx)(s.h2,{id:"send-a-basic-message",children:"Send a basic message"}),"\n",(0,a.jsx)(s.p,{children:"[[sendText]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendText(chatId, "Hello");\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-message-with-mentions",children:"Send a message with mentions"}),"\n",(0,a.jsx)(s.p,{children:"[[sendTextWithMentions]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendTextWithMentions(chatId, "Hello");\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-reply",children:"Send a reply"}),"\n",(0,a.jsx)(s.p,{children:"[[reply]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.reply(chatId, "Hello", idOfMessageToReplyTo);\n\n // set the fourth variable to true to set the chat to \'seen\'\n await client.reply(chatId, "Hello", idOfMessageToReplyTo, true);\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-reply-with-mentions",children:"Send a reply with mentions"}),"\n",(0,a.jsx)(s.p,{children:"[[sendReplyWithMentions]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendReplyWithMentions(chatId, "Hello", idOfMessageToReplyTo);\n'})}),"\n",(0,a.jsx)(s.h2,{id:"forward-messages",children:"Forward Messages"}),"\n",(0,a.jsx)(s.p,{children:"To forward messages use [[forwardMessages]] with the following params:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:["chat to forward messages to : ",(0,a.jsx)(s.a,{href:"mailto:xxxxx@c.us",children:"xxxxx@c.us"})]}),"\n",(0,a.jsx)(s.li,{children:"messages: a single or array of message ids or message objects"}),"\n",(0,a.jsx)(s.li,{children:"skipMyMessages: true or false, if true it will filter out messages sent by you from the list of messages, default false."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:"//forward multiple messages using an array of messageIds\nawait client.forwardMessages('xxxxx@c.us',[Array of Message Ids],true)\n\n//forward single message by id\nawait client.forwardMessages('xxxxx@c.us,\"messageId\",true)\n"})})]})}function h(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>d});var a=n(6540);const t={},i=a.createContext(t);function r(e){const s=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),a.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0057296d.70efed81.js b/assets/js/0057296d.70efed81.js deleted file mode 100644 index cf288f8806..0000000000 --- a/assets/js/0057296d.70efed81.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1482],{3667:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var a=n(4848),t=n(8453);const i={},r="Sending Messages",l={id:"how-to/send-messages",title:"Sending Messages",description:"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.",source:"@site/docs/how-to/send-messages.md",sourceDirName:"how-to",slug:"/how-to/send-messages",permalink:"/docs/how-to/send-messages",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-messages.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Sending Files",permalink:"/docs/how-to/send-files"},next:{title:"Send Video",permalink:"/docs/how-to/send-videos"}},d={},o=[{value:"Send a basic message",id:"send-a-basic-message",level:2},{value:"Send a message with mentions",id:"send-a-message-with-mentions",level:2},{value:"Send a reply",id:"send-a-reply",level:2},{value:"Send a reply with mentions",id:"send-a-reply-with-mentions",level:2},{value:"Forward Messages",id:"forward-messages",level:2}];function c(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.h1,{id:"sending-messages",children:"Sending Messages"}),"\n",(0,a.jsx)(s.p,{children:"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully."}),"\n",(0,a.jsx)(s.h2,{id:"send-a-basic-message",children:"Send a basic message"}),"\n",(0,a.jsx)(s.p,{children:"[[sendText]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendText(chatId, "Hello");\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-message-with-mentions",children:"Send a message with mentions"}),"\n",(0,a.jsx)(s.p,{children:"[[sendTextWithMentions]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendTextWithMentions(chatId, "Hello");\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-reply",children:"Send a reply"}),"\n",(0,a.jsx)(s.p,{children:"[[reply]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.reply(chatId, "Hello", idOfMessageToReplyTo);\n\n // set the fourth variable to true to set the chat to \'seen\'\n await client.reply(chatId, "Hello", idOfMessageToReplyTo, true);\n'})}),"\n",(0,a.jsx)(s.h2,{id:"send-a-reply-with-mentions",children:"Send a reply with mentions"}),"\n",(0,a.jsx)(s.p,{children:"[[sendReplyWithMentions]]"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:' await client.sendReplyWithMentions(chatId, "Hello", idOfMessageToReplyTo);\n'})}),"\n",(0,a.jsx)(s.h2,{id:"forward-messages",children:"Forward Messages"}),"\n",(0,a.jsx)(s.p,{children:"To forward messages use [[forwardMessages]] with the following params:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:["chat to forward messages to : ",(0,a.jsx)(s.a,{href:"mailto:xxxxx@c.us",children:"xxxxx@c.us"})]}),"\n",(0,a.jsx)(s.li,{children:"messages: a single or array of message ids or message objects"}),"\n",(0,a.jsx)(s.li,{children:"skipMyMessages: true or false, if true it will filter out messages sent by you from the list of messages, default false."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-javascript",children:"//forward multiple messages using an array of messageIds\nawait client.forwardMessages('xxxxx@c.us',[Array of Message Ids],true)\n\n//forward single message by id\nawait client.forwardMessages('xxxxx@c.us,\"messageId\",true)\n"})})]})}function h(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>l});var a=n(6540);const t={},i=a.createContext(t);function r(e){const s=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),a.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.4ab44772.js b/assets/js/0058b4c6.8748dd67.js similarity index 99% rename from assets/js/0058b4c6.4ab44772.js rename to assets/js/0058b4c6.8748dd67.js index 177f283adc..414a28cb82 100644 --- a/assets/js/0058b4c6.4ab44772.js +++ b/assets/js/0058b4c6.8748dd67.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[849],{6164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Concepts","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary","href":"/docs/concepts/glossary","docId":"concepts/glossary","unlisted":false},{"type":"link","label":"How does this work?","href":"/docs/concepts/how-it-works","docId":"concepts/how-it-works","unlisted":false}]},{"type":"category","label":"Get Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Easy API","href":"/docs/get-started/quick-run","docId":"get-started/quick-run","unlisted":false},{"type":"link","label":"Docker","href":"/docs/get-started/docker","docId":"get-started/docker","unlisted":false},{"type":"link","label":"Custom Code","href":"/docs/get-started/installation","docId":"get-started/installation","unlisted":false},{"type":"link","label":"Link Code Login","href":"/docs/get-started/link-code","docId":"get-started/link-code","unlisted":false},{"type":"link","label":"Socket mode","href":"/docs/get-started/socketmode","docId":"get-started/socketmode","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"The Config Object","href":"/docs/configuration/config-object","docId":"configuration/config-object","unlisted":false},{"type":"link","label":"EASY API CLI options","href":"/docs/configuration/command-line-options","docId":"configuration/command-line-options","unlisted":false},{"type":"link","label":"The Client","href":"/docs/configuration/the-client","docId":"configuration/the-client","unlisted":false},{"type":"link","label":"Capturing QR Code","href":"/docs/configuration/capture-qr","docId":"configuration/capture-qr","unlisted":false},{"type":"link","label":"Capturing the session data","href":"/docs/configuration/capture-sd","docId":"configuration/capture-sd","unlisted":false},{"type":"link","label":"Launch Events","href":"/docs/configuration/launch-events","docId":"configuration/launch-events","unlisted":false},{"type":"link","label":"Licensed Features","href":"/docs/configuration/licensed-features","docId":"configuration/licensed-features","unlisted":false},{"type":"link","label":"Multiple Sessions","href":"/docs/configuration/multiple-sessions","docId":"configuration/multiple-sessions","unlisted":false}]},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/tutorial-basics/create-a-page","docId":"tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/tutorial-basics/create-a-document","docId":"tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/tutorial-basics/create-a-blog-post","docId":"tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/tutorial-basics/markdown-features","docId":"tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/tutorial-basics/deploy-your-site","docId":"tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/tutorial-basics/congratulations","docId":"tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Best Practice","href":"/docs/advanced/best-practices","docId":"advanced/best-practices","unlisted":false}]},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/tutorial-extras/manage-docs-versions","docId":"tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/tutorial-extras/translate-your-site","docId":"tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"},{"type":"category","label":"Integrations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Chatwoot integrations","href":"/docs/Integrations/chatwoot","docId":"Integrations/chatwoot","unlisted":false}]},{"type":"link","label":"@open-wa/wa-automate v4.71.15","href":"/docs/api/","docId":"api/index","unlisted":false},{"type":"category","label":"How To","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating an API","href":"/docs/how-to/create-api","docId":"how-to/create-api","unlisted":false},{"type":"link","label":"Decrypting Media","href":"/docs/how-to/decrypt-media","docId":"how-to/decrypt-media","unlisted":false},{"type":"link","label":"Detecting Logouts","href":"/docs/how-to/detect-logout","docId":"how-to/detect-logout","unlisted":false},{"type":"link","label":"Group","href":"/docs/how-to/groups","docId":"how-to/groups","unlisted":false},{"type":"link","label":"Error Handling","href":"/docs/how-to/handle-errors","docId":"how-to/handle-errors","unlisted":false},{"type":"link","label":"Handle Incoming Call","href":"/docs/how-to/incoming-calls","docId":"how-to/incoming-calls","unlisted":false},{"type":"link","label":"Location","href":"/docs/how-to/location","docId":"how-to/location","unlisted":false},{"type":"link","label":"Manage Participants","href":"/docs/how-to/manage-participants","docId":"how-to/manage-participants","unlisted":false},{"type":"link","label":"More examples","href":"/docs/how-to/misc","docId":"how-to/misc","unlisted":false},{"type":"link","label":"Reacting To Group Events","href":"/docs/how-to/react-to-group-events","docId":"how-to/react-to-group-events","unlisted":false},{"type":"link","label":"read-state","href":"/docs/how-to/read-state","docId":"how-to/read-state","unlisted":false},{"type":"link","label":"receive-files","href":"/docs/how-to/receive-files","docId":"how-to/receive-files","unlisted":false},{"type":"link","label":"Receiving Messages","href":"/docs/how-to/receive-messages","docId":"how-to/receive-messages","unlisted":false},{"type":"link","label":"Sending Files","href":"/docs/how-to/send-files","docId":"how-to/send-files","unlisted":false},{"type":"link","label":"Sending Messages","href":"/docs/how-to/send-messages","docId":"how-to/send-messages","unlisted":false},{"type":"link","label":"Send Video","href":"/docs/how-to/send-videos","docId":"how-to/send-videos","unlisted":false},{"type":"link","label":"SendFile","href":"/docs/how-to/sendfile","docId":"how-to/sendfile","unlisted":false},{"type":"link","label":"Proxying your session","href":"/docs/how-to/use-a-proxy","docId":"how-to/use-a-proxy","unlisted":false}]},{"type":"category","label":"@open-wa/wa-automate v4.72.3","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/Client","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Client","href":"/docs/reference/api/Client/classes/Client","docId":"reference/api/Client/classes/Client","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: namespace","href":"/docs/reference/api/Client/enumerations/namespace","docId":"reference/api/Client/enumerations/namespace","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: useragent","href":"/docs/reference/api/Client/variables/useragent","docId":"reference/api/Client/variables/useragent","unlisted":false}]}],"href":"/docs/reference/api/Client/"},{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/functions/exposed.enum","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ExposedFn","href":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","docId":"reference/api/functions/exposed.enum/enumerations/ExposedFn","unlisted":false}]}],"href":"/docs/reference/api/functions/exposed.enum/"}]},{"type":"category","label":"api/model","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/model/aliases","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AccountNumber","href":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","docId":"reference/api/model/aliases/type-aliases/AccountNumber","unlisted":false},{"type":"link","label":"Type Alias: AdvancedFile","href":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","docId":"reference/api/model/aliases/type-aliases/AdvancedFile","unlisted":false},{"type":"link","label":"Type Alias: Base64","href":"/docs/reference/api/model/aliases/type-aliases/Base64","docId":"reference/api/model/aliases/type-aliases/Base64","unlisted":false},{"type":"link","label":"Type Alias: ChatId","href":"/docs/reference/api/model/aliases/type-aliases/ChatId","docId":"reference/api/model/aliases/type-aliases/ChatId","unlisted":false},{"type":"link","label":"Type Alias: ChatServer","href":"/docs/reference/api/model/aliases/type-aliases/ChatServer","docId":"reference/api/model/aliases/type-aliases/ChatServer","unlisted":false},{"type":"link","label":"Type Alias: ContactId","href":"/docs/reference/api/model/aliases/type-aliases/ContactId","docId":"reference/api/model/aliases/type-aliases/ContactId","unlisted":false},{"type":"link","label":"Type Alias: Content","href":"/docs/reference/api/model/aliases/type-aliases/Content","docId":"reference/api/model/aliases/type-aliases/Content","unlisted":false},{"type":"link","label":"Type Alias: CountryCode","href":"/docs/reference/api/model/aliases/type-aliases/CountryCode","docId":"reference/api/model/aliases/type-aliases/CountryCode","unlisted":false},{"type":"link","label":"Type Alias: DataURL","href":"/docs/reference/api/model/aliases/type-aliases/DataURL","docId":"reference/api/model/aliases/type-aliases/DataURL","unlisted":false},{"type":"link","label":"Type Alias: FilePath","href":"/docs/reference/api/model/aliases/type-aliases/FilePath","docId":"reference/api/model/aliases/type-aliases/FilePath","unlisted":false},{"type":"link","label":"Type Alias: GetURL","href":"/docs/reference/api/model/aliases/type-aliases/GetURL","docId":"reference/api/model/aliases/type-aliases/GetURL","unlisted":false},{"type":"link","label":"Type Alias: GroupChatId","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","docId":"reference/api/model/aliases/type-aliases/GroupChatId","unlisted":false},{"type":"link","label":"Type Alias: GroupChatServer","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","docId":"reference/api/model/aliases/type-aliases/GroupChatServer","unlisted":false},{"type":"link","label":"Type Alias: GroupId","href":"/docs/reference/api/model/aliases/type-aliases/GroupId","docId":"reference/api/model/aliases/type-aliases/GroupId","unlisted":false},{"type":"link","label":"Type Alias: MessageId","href":"/docs/reference/api/model/aliases/type-aliases/MessageId","docId":"reference/api/model/aliases/type-aliases/MessageId","unlisted":false},{"type":"link","label":"Type Alias: NonSerializedId","href":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","docId":"reference/api/model/aliases/type-aliases/NonSerializedId","unlisted":false},{"type":"link","label":"Type Alias: WaServers","href":"/docs/reference/api/model/aliases/type-aliases/WaServers","docId":"reference/api/model/aliases/type-aliases/WaServers","unlisted":false}]}],"href":"/docs/reference/api/model/aliases/"},{"type":"category","label":"api/model/button","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AdvancedButton","href":"/docs/reference/api/model/button/interfaces/AdvancedButton","docId":"reference/api/model/button/interfaces/AdvancedButton","unlisted":false},{"type":"link","label":"Interface: Button","href":"/docs/reference/api/model/button/interfaces/Button","docId":"reference/api/model/button/interfaces/Button","unlisted":false},{"type":"link","label":"Interface: LocationButtonBody","href":"/docs/reference/api/model/button/interfaces/LocationButtonBody","docId":"reference/api/model/button/interfaces/LocationButtonBody","unlisted":false},{"type":"link","label":"Interface: Row","href":"/docs/reference/api/model/button/interfaces/Row","docId":"reference/api/model/button/interfaces/Row","unlisted":false},{"type":"link","label":"Interface: Section","href":"/docs/reference/api/model/button/interfaces/Section","docId":"reference/api/model/button/interfaces/Section","unlisted":false}]}],"href":"/docs/reference/api/model/button/"},{"type":"category","label":"api/model/call","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CallState","href":"/docs/reference/api/model/call/enumerations/CallState","docId":"reference/api/model/call/enumerations/CallState","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Call","href":"/docs/reference/api/model/call/interfaces/Call","docId":"reference/api/model/call/interfaces/Call","unlisted":false}]}],"href":"/docs/reference/api/model/call/"},{"type":"category","label":"api/model/chat","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ChatMuteDuration","href":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","docId":"reference/api/model/chat/enumerations/ChatMuteDuration","unlisted":false},{"type":"link","label":"Enumeration: ChatState","href":"/docs/reference/api/model/chat/enumerations/ChatState","docId":"reference/api/model/chat/enumerations/ChatState","unlisted":false},{"type":"link","label":"Enumeration: ChatTypes","href":"/docs/reference/api/model/chat/enumerations/ChatTypes","docId":"reference/api/model/chat/enumerations/ChatTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BaseChat","href":"/docs/reference/api/model/chat/interfaces/BaseChat","docId":"reference/api/model/chat/interfaces/BaseChat","unlisted":false},{"type":"link","label":"Interface: GroupChat","href":"/docs/reference/api/model/chat/interfaces/GroupChat","docId":"reference/api/model/chat/interfaces/GroupChat","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationParticipantAddResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationResponse","unlisted":false},{"type":"link","label":"Interface: LiveLocationChangedEvent","href":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","docId":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","unlisted":false},{"type":"link","label":"Interface: SingleChat","href":"/docs/reference/api/model/chat/interfaces/SingleChat","docId":"reference/api/model/chat/interfaces/SingleChat","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Chat","href":"/docs/reference/api/model/chat/type-aliases/Chat","docId":"reference/api/model/chat/type-aliases/Chat","unlisted":false},{"type":"link","label":"Type Alias: EphemeralDuration","href":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","docId":"reference/api/model/chat/type-aliases/EphemeralDuration","unlisted":false}]}],"href":"/docs/reference/api/model/chat/"},{"type":"category","label":"api/model/config","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CLOUD\\\\_PROVIDERS","href":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","docId":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","unlisted":false},{"type":"link","label":"Enumeration: DIRECTORY\\\\_STRATEGY","href":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","docId":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","unlisted":false},{"type":"link","label":"Enumeration: LicenseType","href":"/docs/reference/api/model/config/enumerations/LicenseType","docId":"reference/api/model/config/enumerations/LicenseType","unlisted":false},{"type":"link","label":"Enumeration: NotificationLanguage","href":"/docs/reference/api/model/config/enumerations/NotificationLanguage","docId":"reference/api/model/config/enumerations/NotificationLanguage","unlisted":false},{"type":"link","label":"Enumeration: OnError","href":"/docs/reference/api/model/config/enumerations/OnError","docId":"reference/api/model/config/enumerations/OnError","unlisted":false},{"type":"link","label":"Enumeration: QRFormat","href":"/docs/reference/api/model/config/enumerations/QRFormat","docId":"reference/api/model/config/enumerations/QRFormat","unlisted":false},{"type":"link","label":"Enumeration: QRQuality","href":"/docs/reference/api/model/config/enumerations/QRQuality","docId":"reference/api/model/config/enumerations/QRQuality","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: ConfigObject","href":"/docs/reference/api/model/config/interfaces/ConfigObject","docId":"reference/api/model/config/interfaces/ConfigObject","unlisted":false},{"type":"link","label":"Interface: DevTools","href":"/docs/reference/api/model/config/interfaces/DevTools","docId":"reference/api/model/config/interfaces/DevTools","unlisted":false},{"type":"link","label":"Interface: EventPayload","href":"/docs/reference/api/model/config/interfaces/EventPayload","docId":"reference/api/model/config/interfaces/EventPayload","unlisted":false},{"type":"link","label":"Interface: ProxyServerCredentials","href":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","docId":"reference/api/model/config/interfaces/ProxyServerCredentials","unlisted":false},{"type":"link","label":"Interface: SessionData","href":"/docs/reference/api/model/config/interfaces/SessionData","docId":"reference/api/model/config/interfaces/SessionData","unlisted":false},{"type":"link","label":"Interface: Webhook","href":"/docs/reference/api/model/config/interfaces/Webhook","docId":"reference/api/model/config/interfaces/Webhook","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AdvancedConfig","href":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","docId":"reference/api/model/config/type-aliases/AdvancedConfig","unlisted":false}]}],"href":"/docs/reference/api/model/config/"},{"type":"category","label":"api/model/contact","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BizCategory","href":"/docs/reference/api/model/contact/interfaces/BizCategory","docId":"reference/api/model/contact/interfaces/BizCategory","unlisted":false},{"type":"link","label":"Interface: BizProfileOptions","href":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","docId":"reference/api/model/contact/interfaces/BizProfileOptions","unlisted":false},{"type":"link","label":"Interface: BusinessHours","href":"/docs/reference/api/model/contact/interfaces/BusinessHours","docId":"reference/api/model/contact/interfaces/BusinessHours","unlisted":false},{"type":"link","label":"Interface: BusinessProfile","href":"/docs/reference/api/model/contact/interfaces/BusinessProfile","docId":"reference/api/model/contact/interfaces/BusinessProfile","unlisted":false},{"type":"link","label":"Interface: Contact","href":"/docs/reference/api/model/contact/interfaces/Contact","docId":"reference/api/model/contact/interfaces/Contact","unlisted":false},{"type":"link","label":"Interface: NumberCheck","href":"/docs/reference/api/model/contact/interfaces/NumberCheck","docId":"reference/api/model/contact/interfaces/NumberCheck","unlisted":false}]}],"href":"/docs/reference/api/model/contact/"},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: Events","href":"/docs/reference/api/model/enumerations/Events","docId":"reference/api/model/enumerations/Events","unlisted":false},{"type":"link","label":"Enumeration: STATE","href":"/docs/reference/api/model/enumerations/STATE","docId":"reference/api/model/enumerations/STATE","unlisted":false},{"type":"link","label":"Enumeration: Status","href":"/docs/reference/api/model/enumerations/Status","docId":"reference/api/model/enumerations/Status","unlisted":false}]},{"type":"category","label":"api/model/errors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: AddParticipantError","href":"/docs/reference/api/model/errors/classes/AddParticipantError","docId":"reference/api/model/errors/classes/AddParticipantError","unlisted":false},{"type":"link","label":"Class: CustomError","href":"/docs/reference/api/model/errors/classes/CustomError","docId":"reference/api/model/errors/classes/CustomError","unlisted":false},{"type":"link","label":"Class: PageEvaluationTimeout","href":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","docId":"reference/api/model/errors/classes/PageEvaluationTimeout","unlisted":false},{"type":"link","label":"Class: SessionExpiredError","href":"/docs/reference/api/model/errors/classes/SessionExpiredError","docId":"reference/api/model/errors/classes/SessionExpiredError","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: AddParticipantErrorStatusCode","href":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","docId":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","unlisted":false},{"type":"link","label":"Enumeration: ERROR\\\\_NAME","href":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","docId":"reference/api/model/errors/enumerations/ERROR_NAME","unlisted":false}]}],"href":"/docs/reference/api/model/errors/"},{"type":"category","label":"api/model/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: SimpleListener","href":"/docs/reference/api/model/events/enumerations/SimpleListener","docId":"reference/api/model/events/enumerations/SimpleListener","unlisted":false}]}],"href":"/docs/reference/api/model/events/"},{"type":"category","label":"api/model/group-metadata","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: GroupNotificationTypes","href":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","docId":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","unlisted":false},{"type":"link","label":"Enumeration: groupChangeEvent","href":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","docId":"reference/api/model/group-metadata/enumerations/groupChangeEvent","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: GenericGroupChangeEvent","href":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","docId":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","unlisted":false},{"type":"link","label":"Interface: GroupMetadata","href":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","docId":"reference/api/model/group-metadata/interfaces/GroupMetadata","unlisted":false},{"type":"link","label":"Interface: NewCommunityGroup","href":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","docId":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","unlisted":false},{"type":"link","label":"Interface: Participant","href":"/docs/reference/api/model/group-metadata/interfaces/Participant","docId":"reference/api/model/group-metadata/interfaces/Participant","unlisted":false},{"type":"link","label":"Interface: ParticipantChangedEventModel","href":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","docId":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","unlisted":false}]}],"href":"/docs/reference/api/model/group-metadata/"},{"type":"category","label":"api/model/id","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Id","href":"/docs/reference/api/model/id/interfaces/Id","docId":"reference/api/model/id/interfaces/Id","unlisted":false}]}],"href":"/docs/reference/api/model/id/"},{"type":"category","label":"api/model/label","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Label","href":"/docs/reference/api/model/label/interfaces/Label","docId":"reference/api/model/label/interfaces/Label","unlisted":false}]}],"href":"/docs/reference/api/model/label/"},{"type":"category","label":"api/model/media","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Mp4StickerConversionProcessOptions","href":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","docId":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","unlisted":false},{"type":"link","label":"Type Alias: StickerMetadata","href":"/docs/reference/api/model/media/type-aliases/StickerMetadata","docId":"reference/api/model/media/type-aliases/StickerMetadata","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: defaultProcessOptions","href":"/docs/reference/api/model/media/variables/defaultProcessOptions","docId":"reference/api/model/media/variables/defaultProcessOptions","unlisted":false}]}],"href":"/docs/reference/api/model/media/"},{"type":"category","label":"api/model/message","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: MessageAck","href":"/docs/reference/api/model/message/enumerations/MessageAck","docId":"reference/api/model/message/enumerations/MessageAck","unlisted":false},{"type":"link","label":"Enumeration: MessageTypes","href":"/docs/reference/api/model/message/enumerations/MessageTypes","docId":"reference/api/model/message/enumerations/MessageTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Message","href":"/docs/reference/api/model/message/interfaces/Message","docId":"reference/api/model/message/interfaces/Message","unlisted":false},{"type":"link","label":"Interface: MessageInfo","href":"/docs/reference/api/model/message/interfaces/MessageInfo","docId":"reference/api/model/message/interfaces/MessageInfo","unlisted":false},{"type":"link","label":"Interface: MessageInfoInteraction","href":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","docId":"reference/api/model/message/interfaces/MessageInfoInteraction","unlisted":false},{"type":"link","label":"Interface: PollData","href":"/docs/reference/api/model/message/interfaces/PollData","docId":"reference/api/model/message/interfaces/PollData","unlisted":false},{"type":"link","label":"Interface: PollOption","href":"/docs/reference/api/model/message/interfaces/PollOption","docId":"reference/api/model/message/interfaces/PollOption","unlisted":false},{"type":"link","label":"Interface: PollVote","href":"/docs/reference/api/model/message/interfaces/PollVote","docId":"reference/api/model/message/interfaces/PollVote","unlisted":false},{"type":"link","label":"Interface: QuoteMap","href":"/docs/reference/api/model/message/interfaces/QuoteMap","docId":"reference/api/model/message/interfaces/QuoteMap","unlisted":false},{"type":"link","label":"Interface: ReactionSender","href":"/docs/reference/api/model/message/interfaces/ReactionSender","docId":"reference/api/model/message/interfaces/ReactionSender","unlisted":false}]}],"href":"/docs/reference/api/model/message/"},{"type":"category","label":"api/model/product","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CartItem","href":"/docs/reference/api/model/product/interfaces/CartItem","docId":"reference/api/model/product/interfaces/CartItem","unlisted":false},{"type":"link","label":"Interface: CustomProduct","href":"/docs/reference/api/model/product/interfaces/CustomProduct","docId":"reference/api/model/product/interfaces/CustomProduct","unlisted":false},{"type":"link","label":"Interface: Order","href":"/docs/reference/api/model/product/interfaces/Order","docId":"reference/api/model/product/interfaces/Order","unlisted":false},{"type":"link","label":"Interface: Product","href":"/docs/reference/api/model/product/interfaces/Product","docId":"reference/api/model/product/interfaces/Product","unlisted":false}]}],"href":"/docs/reference/api/model/product/"},{"type":"category","label":"api/model/reactions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Reaction","href":"/docs/reference/api/model/reactions/type-aliases/Reaction","docId":"reference/api/model/reactions/type-aliases/Reaction","unlisted":false},{"type":"link","label":"Type Alias: ReactionEvent","href":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","docId":"reference/api/model/reactions/type-aliases/ReactionEvent","unlisted":false},{"type":"link","label":"Type Alias: ReactionRecord","href":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","docId":"reference/api/model/reactions/type-aliases/ReactionRecord","unlisted":false}]}],"href":"/docs/reference/api/model/reactions/"},{"type":"category","label":"api/model/sessionInfo","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: HealthCheck","href":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","docId":"reference/api/model/sessionInfo/interfaces/HealthCheck","unlisted":false},{"type":"link","label":"Interface: SessionInfo","href":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","docId":"reference/api/model/sessionInfo/interfaces/SessionInfo","unlisted":false}]}],"href":"/docs/reference/api/model/sessionInfo/"},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: EasyApiResponse","href":"/docs/reference/api/model/type-aliases/EasyApiResponse","docId":"reference/api/model/type-aliases/EasyApiResponse","unlisted":false}]}],"href":"/docs/reference/api/model/"}]},{"type":"category","label":"controllers","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"controllers/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: ev","href":"/docs/reference/controllers/events/variables/ev","docId":"reference/controllers/events/variables/ev","unlisted":false}]}],"href":"/docs/reference/controllers/events/"},{"type":"link","label":"controllers/init\\\\_patch","href":"/docs/reference/controllers/init_patch/","docId":"reference/controllers/init_patch/index","unlisted":false},{"type":"category","label":"controllers/initializer","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: create()","href":"/docs/reference/controllers/initializer/functions/create","docId":"reference/controllers/initializer/functions/create","unlisted":false},{"type":"link","label":"Function: timeout()","href":"/docs/reference/controllers/initializer/functions/timeout","docId":"reference/controllers/initializer/functions/timeout","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: configWithCases","href":"/docs/reference/controllers/initializer/variables/configWithCases","docId":"reference/controllers/initializer/variables/configWithCases","unlisted":false},{"type":"link","label":"Variable: pkg","href":"/docs/reference/controllers/initializer/variables/pkg","docId":"reference/controllers/initializer/variables/pkg","unlisted":false},{"type":"link","label":"Variable: screenshot","href":"/docs/reference/controllers/initializer/variables/screenshot","docId":"reference/controllers/initializer/variables/screenshot","unlisted":false}]}],"href":"/docs/reference/controllers/initializer/"},{"type":"category","label":"controllers/patch\\\\_manager","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: earlyInjectionCheck()","href":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","docId":"reference/controllers/patch_manager/functions/earlyInjectionCheck","unlisted":false},{"type":"link","label":"Function: getAndInjectLicense()","href":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","docId":"reference/controllers/patch_manager/functions/getAndInjectLicense","unlisted":false}]}],"href":"/docs/reference/controllers/patch_manager/"}]},{"type":"category","label":"logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"logging/custom\\\\_transport","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: LogToEvTransport","href":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","docId":"reference/logging/custom_transport/classes/LogToEvTransport","unlisted":false},{"type":"link","label":"Class: NoOpTransport","href":"/docs/reference/logging/custom_transport/classes/NoOpTransport","docId":"reference/logging/custom_transport/classes/NoOpTransport","unlisted":false}]}],"href":"/docs/reference/logging/custom_transport/"},{"type":"category","label":"logging/logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: addRotateFileLogTransport()","href":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","docId":"reference/logging/logging/functions/addRotateFileLogTransport","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: ConfigLogTransport","href":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","docId":"reference/logging/logging/type-aliases/ConfigLogTransport","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: log","href":"/docs/reference/logging/logging/variables/log","docId":"reference/logging/logging/variables/log","unlisted":false}]}],"href":"/docs/reference/logging/logging/"}]},{"type":"category","label":"structures","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"structures/Collector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Collection\\\\","href":"/docs/reference/structures/Collector/classes/Collection","docId":"reference/structures/Collector/classes/Collection","unlisted":false},{"type":"link","label":"Class: Collector","href":"/docs/reference/structures/Collector/classes/Collector","docId":"reference/structures/Collector/classes/Collector","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AwaitMessagesOptions","href":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","docId":"reference/structures/Collector/interfaces/AwaitMessagesOptions","unlisted":false},{"type":"link","label":"Interface: CollectorOptions","href":"/docs/reference/structures/Collector/interfaces/CollectorOptions","docId":"reference/structures/Collector/interfaces/CollectorOptions","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CollectorFilter()\\\\","href":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","docId":"reference/structures/Collector/type-aliases/CollectorFilter","unlisted":false}]}],"href":"/docs/reference/structures/Collector/"},{"type":"category","label":"structures/Dialog","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ValidationType","href":"/docs/reference/structures/Dialog/enumerations/ValidationType","docId":"reference/structures/Dialog/enumerations/ValidationType","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CurrentDialogProps","href":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","docId":"reference/structures/Dialog/interfaces/CurrentDialogProps","unlisted":false},{"type":"link","label":"Interface: DialogButtons","href":"/docs/reference/structures/Dialog/interfaces/DialogButtons","docId":"reference/structures/Dialog/interfaces/DialogButtons","unlisted":false},{"type":"link","label":"Interface: DialogListMessageRow","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","docId":"reference/structures/Dialog/interfaces/DialogListMessageRow","unlisted":false},{"type":"link","label":"Interface: DialogListMessageSection","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","docId":"reference/structures/Dialog/interfaces/DialogListMessageSection","unlisted":false},{"type":"link","label":"Interface: DialogProperty","href":"/docs/reference/structures/Dialog/interfaces/DialogProperty","docId":"reference/structures/Dialog/interfaces/DialogProperty","unlisted":false},{"type":"link","label":"Interface: DialogState","href":"/docs/reference/structures/Dialog/interfaces/DialogState","docId":"reference/structures/Dialog/interfaces/DialogState","unlisted":false},{"type":"link","label":"Interface: DialogTemplate","href":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","docId":"reference/structures/Dialog/interfaces/DialogTemplate","unlisted":false},{"type":"link","label":"Interface: DialogValidation","href":"/docs/reference/structures/Dialog/interfaces/DialogValidation","docId":"reference/structures/Dialog/interfaces/DialogValidation","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CheckFunction()","href":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","docId":"reference/structures/Dialog/type-aliases/CheckFunction","unlisted":false}]}],"href":"/docs/reference/structures/Dialog/"},{"type":"category","label":"structures/MessageCollector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: MessageCollector","href":"/docs/reference/structures/MessageCollector/classes/MessageCollector","docId":"reference/structures/MessageCollector/classes/MessageCollector","unlisted":false}]}],"href":"/docs/reference/structures/MessageCollector/"},{"type":"category","label":"structures/preProcessors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: PREPROCESSORS","href":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","docId":"reference/structures/preProcessors/enumerations/PREPROCESSORS","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: MPConfigType","href":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","docId":"reference/structures/preProcessors/type-aliases/MPConfigType","unlisted":false},{"type":"link","label":"Type Alias: MessagePreProcessor()","href":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","docId":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: MessagePreprocessors","href":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","docId":"reference/structures/preProcessors/variables/MessagePreprocessors","unlisted":false}]}],"href":"/docs/reference/structures/preProcessors/"}]}],"href":"/docs/reference/"}]},"docs":{"advanced/best-practices":{"id":"advanced/best-practices","title":"Best Practice","description":"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@open-wa/wa-automate v4.71.15","description":"Modules","sidebar":"tutorialSidebar"},"concepts/glossary":{"id":"concepts/glossary","title":"Glossary of terms","description":"In order to get used to this project, you might find it useful to learn a few regularly used terms","sidebar":"tutorialSidebar"},"concepts/how-it-works":{"id":"concepts/how-it-works","title":"How does this work?","description":"wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the \\"Client\\". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.","sidebar":"tutorialSidebar"},"configuration/capture-qr":{"id":"configuration/capture-qr","title":"Capturing QR Code","description":"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.","sidebar":"tutorialSidebar"},"configuration/capture-sd":{"id":"configuration/capture-sd","title":"Capturing the session data","description":"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.","sidebar":"tutorialSidebar"},"configuration/command-line-options":{"id":"configuration/command-line-options","title":"EASY API CLI options","description":"Command-line options reference documentation.","sidebar":"tutorialSidebar"},"configuration/config-object":{"id":"configuration/config-object","title":"Configuration","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"configuration/launch-events":{"id":"configuration/launch-events","title":"Launch Events","description":"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:","sidebar":"tutorialSidebar"},"configuration/licensed-features":{"id":"configuration/licensed-features","title":"Licensed Features","description":"Features","sidebar":"tutorialSidebar"},"configuration/multiple-sessions":{"id":"configuration/multiple-sessions","title":"Multiple Sessions","description":"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:","sidebar":"tutorialSidebar"},"configuration/the-client":{"id":"configuration/the-client","title":"The Client","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"get-started/docker":{"id":"get-started/docker","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/installation":{"id":"get-started/installation","title":"Custom Code","description":"Standard Installation","sidebar":"tutorialSidebar"},"get-started/link-code":{"id":"get-started/link-code","title":"Logging in with a link code","description":"Simple docs showing how to use open-wa/wa-automate with a link code.","sidebar":"tutorialSidebar"},"get-started/quick-run":{"id":"get-started/quick-run","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket mode","description":"Guide showing how to develop your own solutions without needing to wait for session restarts.","sidebar":"tutorialSidebar"},"how-to/create-api":{"id":"how-to/create-api","title":"Creating an API","description":"There are multiple convinient ways to create an API.","sidebar":"tutorialSidebar"},"how-to/decrypt-media":{"id":"how-to/decrypt-media","title":"Decrypting Media","description":"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.","sidebar":"tutorialSidebar"},"how-to/detect-logout":{"id":"how-to/detect-logout","title":"Detecting Logouts","description":"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.","sidebar":"tutorialSidebar"},"how-to/groups":{"id":"how-to/groups","title":"Group","description":"Create a Group","sidebar":"tutorialSidebar"},"how-to/handle-errors":{"id":"how-to/handle-errors","title":"Error Handling","description":"Keep your promises!","sidebar":"tutorialSidebar"},"how-to/incoming-calls":{"id":"how-to/incoming-calls","title":"Handle Incoming Call","description":"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number","sidebar":"tutorialSidebar"},"how-to/location":{"id":"how-to/location","title":"Location","description":"Sending Location","sidebar":"tutorialSidebar"},"how-to/manage-participants":{"id":"how-to/manage-participants","title":"Manage Participants","description":"[[addParticipant]] - add a participant","sidebar":"tutorialSidebar"},"how-to/misc":{"id":"how-to/misc","title":"More examples","description":"Simulate typing","sidebar":"tutorialSidebar"},"how-to/react-to-group-events":{"id":"how-to/react-to-group-events","title":"Reacting To Group Events","description":"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).","sidebar":"tutorialSidebar"},"how-to/read-state":{"id":"how-to/read-state","title":"read-state","description":"","sidebar":"tutorialSidebar"},"how-to/receive-files":{"id":"how-to/receive-files","title":"receive-files","description":"","sidebar":"tutorialSidebar"},"how-to/receive-messages":{"id":"how-to/receive-messages","title":"Receiving Messages","description":"Listen to only incoming messages","sidebar":"tutorialSidebar"},"how-to/send-files":{"id":"how-to/send-files","title":"Sending Files","description":"Send Image","sidebar":"tutorialSidebar"},"how-to/send-messages":{"id":"how-to/send-messages","title":"Sending Messages","description":"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.","sidebar":"tutorialSidebar"},"how-to/send-videos":{"id":"how-to/send-videos","title":"Send Video","description":"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.","sidebar":"tutorialSidebar"},"how-to/sendfile":{"id":"how-to/sendfile","title":"SendFile","description":"","sidebar":"tutorialSidebar"},"how-to/use-a-proxy":{"id":"how-to/use-a-proxy","title":"Proxying your session","description":"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:","sidebar":"tutorialSidebar"},"Integrations/chatwoot":{"id":"Integrations/chatwoot","title":"Chatwoot integrations","description":"ready made integration for chatwoot.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.","sidebar":"tutorialSidebar"},"reference/api/Client/classes/Client":{"id":"reference/api/Client/classes/Client","title":"Class: Client","description":"Methods","sidebar":"tutorialSidebar"},"reference/api/Client/enumerations/namespace":{"id":"reference/api/Client/enumerations/namespace","title":"Enumeration: namespace","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/Client/index":{"id":"reference/api/Client/index","title":"api/Client","description":"Index","sidebar":"tutorialSidebar"},"reference/api/Client/variables/useragent":{"id":"reference/api/Client/variables/useragent","title":"Variable: useragent","description":"const useragent: string","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/enumerations/ExposedFn":{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","title":"Enumeration: ExposedFn","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/index":{"id":"reference/api/functions/exposed.enum/index","title":"api/functions/exposed.enum","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/index":{"id":"reference/api/model/aliases/index","title":"api/model/aliases","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AccountNumber":{"id":"reference/api/model/aliases/type-aliases/AccountNumber","title":"Type Alias: AccountNumber","description":"AccountNumber: \\\\$\\\\{number\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AdvancedFile":{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","title":"Type Alias: AdvancedFile","description":"AdvancedFile: DataURL \\\\| FilePath \\\\| GetURL","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Base64":{"id":"reference/api/model/aliases/type-aliases/Base64","title":"Type Alias: Base64","description":"Base64: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatId":{"id":"reference/api/model/aliases/type-aliases/ChatId","title":"Type Alias: ChatId","description":"ChatId: ContactId \\\\| GroupChatId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatServer":{"id":"reference/api/model/aliases/type-aliases/ChatServer","title":"Type Alias: ChatServer","description":"ChatServer: \\"c.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ContactId":{"id":"reference/api/model/aliases/type-aliases/ContactId","title":"Type Alias: ContactId","description":"ContactId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Content":{"id":"reference/api/model/aliases/type-aliases/Content","title":"Type Alias: Content","description":"Content: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/CountryCode":{"id":"reference/api/model/aliases/type-aliases/CountryCode","title":"Type Alias: CountryCode","description":"CountryCode: 1 \\\\| 7 \\\\| 20 \\\\| 27 \\\\| 30 \\\\| 31 \\\\| 32 \\\\| 33 \\\\| 34 \\\\| 36 \\\\| 39 \\\\| 40 \\\\| 41 \\\\| 43 \\\\| 44 \\\\| 45 \\\\| 46 \\\\| 47 \\\\| 48 \\\\| 49 \\\\| 51 \\\\| 52 \\\\| 53 \\\\| 54 \\\\| 55 \\\\| 56 \\\\| 57 \\\\| 58 \\\\| 60 \\\\| 61 \\\\| 62 \\\\| 63 \\\\| 64 \\\\| 65 \\\\| 66 \\\\| 81 \\\\| 82 \\\\| 84 \\\\| 86 \\\\| 90 \\\\| 91 \\\\| 92 \\\\| 93 \\\\| 94 \\\\| 95 \\\\| 98 \\\\| 211 \\\\| 212 \\\\| 213 \\\\| 216 \\\\| 218 \\\\| 220 \\\\| 221 \\\\| 222 \\\\| 223 \\\\| 224 \\\\| 225 \\\\| 226 \\\\| 227 \\\\| 228 \\\\| 229 \\\\| 230 \\\\| 231 \\\\| 232 \\\\| 233 \\\\| 234 \\\\| 235 \\\\| 236 \\\\| 237 \\\\| 238 \\\\| 239 \\\\| 240 \\\\| 241 \\\\| 242 \\\\| 243 \\\\| 244 \\\\| 245 \\\\| 246 \\\\| 248 \\\\| 249 \\\\| 250 \\\\| 251 \\\\| 252 \\\\| 253 \\\\| 254 \\\\| 255 \\\\| 256 \\\\| 257 \\\\| 258 \\\\| 260 \\\\| 261 \\\\| 262 \\\\| 263 \\\\| 264 \\\\| 265 \\\\| 266 \\\\| 267 \\\\| 268 \\\\| 269 \\\\| 290 \\\\| 291 \\\\| 297 \\\\| 298 \\\\| 299 \\\\| 350 \\\\| 351 \\\\| 352 \\\\| 353 \\\\| 354 \\\\| 355 \\\\| 356 \\\\| 357 \\\\| 358 \\\\| 359 \\\\| 370 \\\\| 371 \\\\| 372 \\\\| 373 \\\\| 374 \\\\| 375 \\\\| 376 \\\\| 377 \\\\| 378 \\\\| 380 \\\\| 381 \\\\| 382 \\\\| 383 \\\\| 385 \\\\| 386 \\\\| 387 \\\\| 389 \\\\| 420 \\\\| 421 \\\\| 423 \\\\| 500 \\\\| 501 \\\\| 502 \\\\| 503 \\\\| 504 \\\\| 505 \\\\| 506 \\\\| 507 \\\\| 508 \\\\| 509 \\\\| 590 \\\\| 591 \\\\| 592 \\\\| 593 \\\\| 594 \\\\| 595 \\\\| 596 \\\\| 597 \\\\| 598 \\\\| 599 \\\\| 670 \\\\| 672 \\\\| 673 \\\\| 674 \\\\| 675 \\\\| 676 \\\\| 677 \\\\| 678 \\\\| 679 \\\\| 680 \\\\| 681 \\\\| 682 \\\\| 683 \\\\| 685 \\\\| 686 \\\\| 687 \\\\| 688 \\\\| 689 \\\\| 690 \\\\| 691 \\\\| 692 \\\\| 850 \\\\| 852 \\\\| 853 \\\\| 855 \\\\| 856 \\\\| 880 \\\\| 886 \\\\| 960 \\\\| 961 \\\\| 962 \\\\| 963 \\\\| 964 \\\\| 965 \\\\| 966 \\\\| 967 \\\\| 968 \\\\| 970 \\\\| 971 \\\\| 972 \\\\| 973 \\\\| 974 \\\\| 975 \\\\| 976 \\\\| 977 \\\\| 992 \\\\| 993 \\\\| 994 \\\\| 995 \\\\| 996 \\\\| 998","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/DataURL":{"id":"reference/api/model/aliases/type-aliases/DataURL","title":"Type Alias: DataURL","description":"DataURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/FilePath":{"id":"reference/api/model/aliases/type-aliases/FilePath","title":"Type Alias: FilePath","description":"FilePath: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GetURL":{"id":"reference/api/model/aliases/type-aliases/GetURL","title":"Type Alias: GetURL","description":"GetURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatId":{"id":"reference/api/model/aliases/type-aliases/GroupChatId","title":"Type Alias: GroupChatId","description":"GroupChatId: \\\\$\\\\{AccountNumber\\\\}-$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\ \\\\| GroupId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatServer":{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","title":"Type Alias: GroupChatServer","description":"GroupChatServer: \\"g.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupId":{"id":"reference/api/model/aliases/type-aliases/GroupId","title":"Type Alias: GroupId","description":"GroupId: \\\\$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/MessageId":{"id":"reference/api/model/aliases/type-aliases/MessageId","title":"Type Alias: MessageId","description":"MessageId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/NonSerializedId":{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","title":"Type Alias: NonSerializedId","description":"NonSerializedId: object","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/WaServers":{"id":"reference/api/model/aliases/type-aliases/WaServers","title":"Type Alias: WaServers","description":"WaServers: ChatServer \\\\| GroupChatServer","sidebar":"tutorialSidebar"},"reference/api/model/button/index":{"id":"reference/api/model/button/index","title":"api/model/button","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/AdvancedButton":{"id":"reference/api/model/button/interfaces/AdvancedButton","title":"Interface: AdvancedButton","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Button":{"id":"reference/api/model/button/interfaces/Button","title":"Interface: Button","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/LocationButtonBody":{"id":"reference/api/model/button/interfaces/LocationButtonBody","title":"Interface: LocationButtonBody","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Row":{"id":"reference/api/model/button/interfaces/Row","title":"Interface: Row","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Section":{"id":"reference/api/model/button/interfaces/Section","title":"Interface: Section","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/call/enumerations/CallState":{"id":"reference/api/model/call/enumerations/CallState","title":"Enumeration: CallState","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/call/index":{"id":"reference/api/model/call/index","title":"api/model/call","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/call/interfaces/Call":{"id":"reference/api/model/call/interfaces/Call","title":"Interface: Call","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatMuteDuration":{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","title":"Enumeration: ChatMuteDuration","description":"Valid durations for muting a chat using [[muteChat]]","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatState":{"id":"reference/api/model/chat/enumerations/ChatState","title":"Enumeration: ChatState","description":"The ChatState represents the state you\'d normally see represented under the chat name in the app.","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatTypes":{"id":"reference/api/model/chat/enumerations/ChatTypes","title":"Enumeration: ChatTypes","description":"Chat types","sidebar":"tutorialSidebar"},"reference/api/model/chat/index":{"id":"reference/api/model/chat/index","title":"api/model/chat","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/BaseChat":{"id":"reference/api/model/chat/interfaces/BaseChat","title":"Interface: BaseChat","description":"Extended by","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChat":{"id":"reference/api/model/chat/interfaces/GroupChat","title":"Interface: GroupChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","title":"Interface: GroupChatCreationParticipantAddResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","title":"Interface: GroupChatCreationResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/LiveLocationChangedEvent":{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","title":"Interface: LiveLocationChangedEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/SingleChat":{"id":"reference/api/model/chat/interfaces/SingleChat","title":"Interface: SingleChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/Chat":{"id":"reference/api/model/chat/type-aliases/Chat","title":"Type Alias: Chat","description":"Chat: SingleChat \\\\| GroupChat","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/EphemeralDuration":{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","title":"Type Alias: EphemeralDuration","description":"EphemeralDuration: 86400 \\\\| 604800 \\\\| 7776000","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/CLOUD_PROVIDERS":{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","title":"Enumeration: CLOUD\\\\_PROVIDERS","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/DIRECTORY_STRATEGY":{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","title":"Enumeration: DIRECTORY\\\\_STRATEGY","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/LicenseType":{"id":"reference/api/model/config/enumerations/LicenseType","title":"Enumeration: LicenseType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/NotificationLanguage":{"id":"reference/api/model/config/enumerations/NotificationLanguage","title":"Enumeration: NotificationLanguage","description":"The available languages for the host security notification","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/OnError":{"id":"reference/api/model/config/enumerations/OnError","title":"Enumeration: OnError","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRFormat":{"id":"reference/api/model/config/enumerations/QRFormat","title":"Enumeration: QRFormat","description":"The different types of qr code output.","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRQuality":{"id":"reference/api/model/config/enumerations/QRQuality","title":"Enumeration: QRQuality","description":"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.","sidebar":"tutorialSidebar"},"reference/api/model/config/index":{"id":"reference/api/model/config/index","title":"api/model/config","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ConfigObject":{"id":"reference/api/model/config/interfaces/ConfigObject","title":"Interface: ConfigObject","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/DevTools":{"id":"reference/api/model/config/interfaces/DevTools","title":"Interface: DevTools","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/EventPayload":{"id":"reference/api/model/config/interfaces/EventPayload","title":"Interface: EventPayload","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ProxyServerCredentials":{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","title":"Interface: ProxyServerCredentials","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/SessionData":{"id":"reference/api/model/config/interfaces/SessionData","title":"Interface: SessionData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/Webhook":{"id":"reference/api/model/config/interfaces/Webhook","title":"Interface: Webhook","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/type-aliases/AdvancedConfig":{"id":"reference/api/model/config/type-aliases/AdvancedConfig","title":"Type Alias: AdvancedConfig","description":"AdvancedConfig: ConfigObject & object","sidebar":"tutorialSidebar"},"reference/api/model/contact/index":{"id":"reference/api/model/contact/index","title":"api/model/contact","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizCategory":{"id":"reference/api/model/contact/interfaces/BizCategory","title":"Interface: BizCategory","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizProfileOptions":{"id":"reference/api/model/contact/interfaces/BizProfileOptions","title":"Interface: BizProfileOptions","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessHours":{"id":"reference/api/model/contact/interfaces/BusinessHours","title":"Interface: BusinessHours","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessProfile":{"id":"reference/api/model/contact/interfaces/BusinessProfile","title":"Interface: BusinessProfile","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/Contact":{"id":"reference/api/model/contact/interfaces/Contact","title":"Interface: Contact","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/NumberCheck":{"id":"reference/api/model/contact/interfaces/NumberCheck","title":"Interface: NumberCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Events":{"id":"reference/api/model/enumerations/Events","title":"Enumeration: Events","description":"Events that can be emitted by the client","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/STATE":{"id":"reference/api/model/enumerations/STATE","title":"Enumeration: STATE","description":"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren\'t understood completely.","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Status":{"id":"reference/api/model/enumerations/Status","title":"Enumeration: Status","description":"Client status","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/AddParticipantError":{"id":"reference/api/model/errors/classes/AddParticipantError","title":"Class: AddParticipantError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/CustomError":{"id":"reference/api/model/errors/classes/CustomError","title":"Class: CustomError","description":"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/PageEvaluationTimeout":{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","title":"Class: PageEvaluationTimeout","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/SessionExpiredError":{"id":"reference/api/model/errors/classes/SessionExpiredError","title":"Class: SessionExpiredError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode":{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","title":"Enumeration: AddParticipantErrorStatusCode","description":"Add Participants Status Code Enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/ERROR_NAME":{"id":"reference/api/model/errors/enumerations/ERROR_NAME","title":"Enumeration: ERROR\\\\_NAME","description":"Enum of error names specific to this library","sidebar":"tutorialSidebar"},"reference/api/model/errors/index":{"id":"reference/api/model/errors/index","title":"api/model/errors","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/events/enumerations/SimpleListener":{"id":"reference/api/model/events/enumerations/SimpleListener","title":"Enumeration: SimpleListener","description":"An enum of all the \\"simple listeners\\". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.","sidebar":"tutorialSidebar"},"reference/api/model/events/index":{"id":"reference/api/model/events/index","title":"api/model/events","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/groupChangeEvent":{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","title":"Enumeration: groupChangeEvent","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/GroupNotificationTypes":{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","title":"Enumeration: GroupNotificationTypes","description":"Group notification types","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/index":{"id":"reference/api/model/group-metadata/index","title":"api/model/group-metadata","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent":{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","title":"Interface: GenericGroupChangeEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GroupMetadata":{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","title":"Interface: GroupMetadata","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/NewCommunityGroup":{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","title":"Interface: NewCommunityGroup","description":"Used when creating a new community with.","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/Participant":{"id":"reference/api/model/group-metadata/interfaces/Participant","title":"Interface: Participant","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel":{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","title":"Interface: ParticipantChangedEventModel","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/id/index":{"id":"reference/api/model/id/index","title":"api/model/id","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/id/interfaces/Id":{"id":"reference/api/model/id/interfaces/Id","title":"Interface: Id","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/index":{"id":"reference/api/model/index","title":"api/model","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/index":{"id":"reference/api/model/label/index","title":"api/model/label","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/interfaces/Label":{"id":"reference/api/model/label/interfaces/Label","title":"Interface: Label","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/media/index":{"id":"reference/api/model/media/index","title":"api/model/media","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions":{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","title":"Type Alias: Mp4StickerConversionProcessOptions","description":"Mp4StickerConversionProcessOptions: object","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/StickerMetadata":{"id":"reference/api/model/media/type-aliases/StickerMetadata","title":"Type Alias: StickerMetadata","description":"StickerMetadata: object","sidebar":"tutorialSidebar"},"reference/api/model/media/variables/defaultProcessOptions":{"id":"reference/api/model/media/variables/defaultProcessOptions","title":"Variable: defaultProcessOptions","description":"const defaultProcessOptions: Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageAck":{"id":"reference/api/model/message/enumerations/MessageAck","title":"Enumeration: MessageAck","description":"Message ACK","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageTypes":{"id":"reference/api/model/message/enumerations/MessageTypes","title":"Enumeration: MessageTypes","description":"Message types","sidebar":"tutorialSidebar"},"reference/api/model/message/index":{"id":"reference/api/model/message/index","title":"api/model/message","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/Message":{"id":"reference/api/model/message/interfaces/Message","title":"Interface: Message","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfo":{"id":"reference/api/model/message/interfaces/MessageInfo","title":"Interface: MessageInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfoInteraction":{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","title":"Interface: MessageInfoInteraction","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollData":{"id":"reference/api/model/message/interfaces/PollData","title":"Interface: PollData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollOption":{"id":"reference/api/model/message/interfaces/PollOption","title":"Interface: PollOption","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollVote":{"id":"reference/api/model/message/interfaces/PollVote","title":"Interface: PollVote","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/QuoteMap":{"id":"reference/api/model/message/interfaces/QuoteMap","title":"Interface: QuoteMap","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/ReactionSender":{"id":"reference/api/model/message/interfaces/ReactionSender","title":"Interface: ReactionSender","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/index":{"id":"reference/api/model/product/index","title":"api/model/product","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CartItem":{"id":"reference/api/model/product/interfaces/CartItem","title":"Interface: CartItem","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CustomProduct":{"id":"reference/api/model/product/interfaces/CustomProduct","title":"Interface: CustomProduct","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Order":{"id":"reference/api/model/product/interfaces/Order","title":"Interface: Order","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Product":{"id":"reference/api/model/product/interfaces/Product","title":"Interface: Product","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/reactions/index":{"id":"reference/api/model/reactions/index","title":"api/model/reactions","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/Reaction":{"id":"reference/api/model/reactions/type-aliases/Reaction","title":"Type Alias: Reaction","description":"Reaction: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionEvent":{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","title":"Type Alias: ReactionEvent","description":"ReactionEvent: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionRecord":{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","title":"Type Alias: ReactionRecord","description":"ReactionRecord: object","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/index":{"id":"reference/api/model/sessionInfo/index","title":"api/model/sessionInfo","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/HealthCheck":{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","title":"Interface: HealthCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/SessionInfo":{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","title":"Interface: SessionInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/type-aliases/EasyApiResponse":{"id":"reference/api/model/type-aliases/EasyApiResponse","title":"Type Alias: EasyApiResponse","description":"EasyApiResponse: object","sidebar":"tutorialSidebar"},"reference/controllers/events/index":{"id":"reference/controllers/events/index","title":"controllers/events","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/events/variables/ev":{"id":"reference/controllers/events/variables/ev","title":"Variable: ev","description":"const ev: EventEmitter2","sidebar":"tutorialSidebar"},"reference/controllers/init_patch/index":{"id":"reference/controllers/init_patch/index","title":"controllers/init\\\\_patch","description":"","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/create":{"id":"reference/controllers/initializer/functions/create","title":"Function: create()","description":"create(config): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/timeout":{"id":"reference/controllers/initializer/functions/timeout","title":"Function: timeout()","description":"timeout(ms): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/index":{"id":"reference/controllers/initializer/index","title":"controllers/initializer","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/configWithCases":{"id":"reference/controllers/initializer/variables/configWithCases","title":"Variable: configWithCases","description":"const configWithCases: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/pkg":{"id":"reference/controllers/initializer/variables/pkg","title":"Variable: pkg","description":"const pkg: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/screenshot":{"id":"reference/controllers/initializer/variables/screenshot","title":"Variable: screenshot","description":"screenshot: any","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/earlyInjectionCheck":{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","title":"Function: earlyInjectionCheck()","description":"earlyInjectionCheck(page): Promise\\\\ boolean\\\\>","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/getAndInjectLicense":{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","title":"Function: getAndInjectLicense()","description":"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/index":{"id":"reference/controllers/patch_manager/index","title":"controllers/patch\\\\_manager","description":"Index","sidebar":"tutorialSidebar"},"reference/index":{"id":"reference/index","title":"@open-wa/wa-automate v4.72.3","description":"Modules","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/LogToEvTransport":{"id":"reference/logging/custom_transport/classes/LogToEvTransport","title":"Class: LogToEvTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/NoOpTransport":{"id":"reference/logging/custom_transport/classes/NoOpTransport","title":"Class: NoOpTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/index":{"id":"reference/logging/custom_transport/index","title":"logging/custom\\\\_transport","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/functions/addRotateFileLogTransport":{"id":"reference/logging/logging/functions/addRotateFileLogTransport","title":"Function: addRotateFileLogTransport()","description":"addRotateFileLogTransport(options): void","sidebar":"tutorialSidebar"},"reference/logging/logging/index":{"id":"reference/logging/logging/index","title":"logging/logging","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/type-aliases/ConfigLogTransport":{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","title":"Type Alias: ConfigLogTransport","description":"ConfigLogTransport: object","sidebar":"tutorialSidebar"},"reference/logging/logging/variables/log":{"id":"reference/logging/logging/variables/log","title":"Variable: log","description":"const log: Logger","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collection":{"id":"reference/structures/Collector/classes/Collection","title":"Class: Collection\\\\","description":"Extends","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collector":{"id":"reference/structures/Collector/classes/Collector","title":"Class: Collector","description":"Abstract class for defining a new Collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/index":{"id":"reference/structures/Collector/index","title":"structures/Collector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/AwaitMessagesOptions":{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","title":"Interface: AwaitMessagesOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/CollectorOptions":{"id":"reference/structures/Collector/interfaces/CollectorOptions","title":"Interface: CollectorOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/type-aliases/CollectorFilter":{"id":"reference/structures/Collector/type-aliases/CollectorFilter","title":"Type Alias: CollectorFilter()\\\\","description":"CollectorFilter\\\\: (...args) => boolean \\\\| Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/Dialog/enumerations/ValidationType":{"id":"reference/structures/Dialog/enumerations/ValidationType","title":"Enumeration: ValidationType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/structures/Dialog/index":{"id":"reference/structures/Dialog/index","title":"structures/Dialog","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/CurrentDialogProps":{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","title":"Interface: CurrentDialogProps","description":"Indexable","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogButtons":{"id":"reference/structures/Dialog/interfaces/DialogButtons","title":"Interface: DialogButtons","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageRow":{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","title":"Interface: DialogListMessageRow","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageSection":{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","title":"Interface: DialogListMessageSection","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogProperty":{"id":"reference/structures/Dialog/interfaces/DialogProperty","title":"Interface: DialogProperty","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogState":{"id":"reference/structures/Dialog/interfaces/DialogState","title":"Interface: DialogState","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogTemplate":{"id":"reference/structures/Dialog/interfaces/DialogTemplate","title":"Interface: DialogTemplate","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogValidation":{"id":"reference/structures/Dialog/interfaces/DialogValidation","title":"Interface: DialogValidation","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/type-aliases/CheckFunction":{"id":"reference/structures/Dialog/type-aliases/CheckFunction","title":"Type Alias: CheckFunction()","description":"CheckFunction: (lastReceivedMessage, currentProps) => boolean","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/classes/MessageCollector":{"id":"reference/structures/MessageCollector/classes/MessageCollector","title":"Class: MessageCollector","description":"Collects messages on a chat.","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/index":{"id":"reference/structures/MessageCollector/index","title":"structures/MessageCollector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/enumerations/PREPROCESSORS":{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","title":"Enumeration: PREPROCESSORS","description":"A set of easy to use, built-in message processors.","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/index":{"id":"reference/structures/preProcessors/index","title":"structures/preProcessors","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MessagePreProcessor":{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","title":"Type Alias: MessagePreProcessor()","description":"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MPConfigType":{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","title":"Type Alias: MPConfigType","description":"MPConfigType: PREPROCESSORS \\\\| MessagePreProcessor \\\\| (PREPROCESSORS \\\\| MessagePreProcessor)[]","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/variables/MessagePreprocessors":{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","title":"Variable: MessagePreprocessors","description":"const MessagePreprocessors: object","sidebar":"tutorialSidebar"},"tutorial-basics/congratulations":{"id":"tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-blog-post":{"id":"tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-document":{"id":"tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-page":{"id":"tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"tutorialSidebar"},"tutorial-basics/deploy-your-site":{"id":"tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"tutorialSidebar"},"tutorial-basics/markdown-features":{"id":"tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"tutorialSidebar"},"tutorial-extras/manage-docs-versions":{"id":"tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"tutorialSidebar"},"tutorial-extras/translate-your-site":{"id":"tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[849],{6164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Concepts","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary","href":"/docs/concepts/glossary","docId":"concepts/glossary","unlisted":false},{"type":"link","label":"How does this work?","href":"/docs/concepts/how-it-works","docId":"concepts/how-it-works","unlisted":false}]},{"type":"category","label":"Get Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Easy API","href":"/docs/get-started/quick-run","docId":"get-started/quick-run","unlisted":false},{"type":"link","label":"Docker","href":"/docs/get-started/docker","docId":"get-started/docker","unlisted":false},{"type":"link","label":"Custom Code","href":"/docs/get-started/installation","docId":"get-started/installation","unlisted":false},{"type":"link","label":"Link Code Login","href":"/docs/get-started/link-code","docId":"get-started/link-code","unlisted":false},{"type":"link","label":"Socket mode","href":"/docs/get-started/socketmode","docId":"get-started/socketmode","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"The Config Object","href":"/docs/configuration/config-object","docId":"configuration/config-object","unlisted":false},{"type":"link","label":"EASY API CLI options","href":"/docs/configuration/command-line-options","docId":"configuration/command-line-options","unlisted":false},{"type":"link","label":"The Client","href":"/docs/configuration/the-client","docId":"configuration/the-client","unlisted":false},{"type":"link","label":"Capturing QR Code","href":"/docs/configuration/capture-qr","docId":"configuration/capture-qr","unlisted":false},{"type":"link","label":"Capturing the session data","href":"/docs/configuration/capture-sd","docId":"configuration/capture-sd","unlisted":false},{"type":"link","label":"Launch Events","href":"/docs/configuration/launch-events","docId":"configuration/launch-events","unlisted":false},{"type":"link","label":"Licensed Features","href":"/docs/configuration/licensed-features","docId":"configuration/licensed-features","unlisted":false},{"type":"link","label":"Multiple Sessions","href":"/docs/configuration/multiple-sessions","docId":"configuration/multiple-sessions","unlisted":false}]},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/tutorial-basics/create-a-page","docId":"tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/tutorial-basics/create-a-document","docId":"tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/tutorial-basics/create-a-blog-post","docId":"tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/tutorial-basics/markdown-features","docId":"tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/tutorial-basics/deploy-your-site","docId":"tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/tutorial-basics/congratulations","docId":"tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Best Practice","href":"/docs/advanced/best-practices","docId":"advanced/best-practices","unlisted":false}]},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/tutorial-extras/manage-docs-versions","docId":"tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/tutorial-extras/translate-your-site","docId":"tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"},{"type":"category","label":"Integrations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Chatwoot integrations","href":"/docs/Integrations/chatwoot","docId":"Integrations/chatwoot","unlisted":false}]},{"type":"link","label":"@open-wa/wa-automate v4.71.15","href":"/docs/api/","docId":"api/index","unlisted":false},{"type":"category","label":"How To","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating an API","href":"/docs/how-to/create-api","docId":"how-to/create-api","unlisted":false},{"type":"link","label":"Decrypting Media","href":"/docs/how-to/decrypt-media","docId":"how-to/decrypt-media","unlisted":false},{"type":"link","label":"Detecting Logouts","href":"/docs/how-to/detect-logout","docId":"how-to/detect-logout","unlisted":false},{"type":"link","label":"Group","href":"/docs/how-to/groups","docId":"how-to/groups","unlisted":false},{"type":"link","label":"Error Handling","href":"/docs/how-to/handle-errors","docId":"how-to/handle-errors","unlisted":false},{"type":"link","label":"Handle Incoming Call","href":"/docs/how-to/incoming-calls","docId":"how-to/incoming-calls","unlisted":false},{"type":"link","label":"Location","href":"/docs/how-to/location","docId":"how-to/location","unlisted":false},{"type":"link","label":"Manage Participants","href":"/docs/how-to/manage-participants","docId":"how-to/manage-participants","unlisted":false},{"type":"link","label":"More examples","href":"/docs/how-to/misc","docId":"how-to/misc","unlisted":false},{"type":"link","label":"Reacting To Group Events","href":"/docs/how-to/react-to-group-events","docId":"how-to/react-to-group-events","unlisted":false},{"type":"link","label":"read-state","href":"/docs/how-to/read-state","docId":"how-to/read-state","unlisted":false},{"type":"link","label":"receive-files","href":"/docs/how-to/receive-files","docId":"how-to/receive-files","unlisted":false},{"type":"link","label":"Receiving Messages","href":"/docs/how-to/receive-messages","docId":"how-to/receive-messages","unlisted":false},{"type":"link","label":"Sending Files","href":"/docs/how-to/send-files","docId":"how-to/send-files","unlisted":false},{"type":"link","label":"Sending Messages","href":"/docs/how-to/send-messages","docId":"how-to/send-messages","unlisted":false},{"type":"link","label":"Send Video","href":"/docs/how-to/send-videos","docId":"how-to/send-videos","unlisted":false},{"type":"link","label":"SendFile","href":"/docs/how-to/sendfile","docId":"how-to/sendfile","unlisted":false},{"type":"link","label":"Proxying your session","href":"/docs/how-to/use-a-proxy","docId":"how-to/use-a-proxy","unlisted":false}]},{"type":"category","label":"@open-wa/wa-automate v4.72.4","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/Client","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Client","href":"/docs/reference/api/Client/classes/Client","docId":"reference/api/Client/classes/Client","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: namespace","href":"/docs/reference/api/Client/enumerations/namespace","docId":"reference/api/Client/enumerations/namespace","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: useragent","href":"/docs/reference/api/Client/variables/useragent","docId":"reference/api/Client/variables/useragent","unlisted":false}]}],"href":"/docs/reference/api/Client/"},{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/functions/exposed.enum","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ExposedFn","href":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","docId":"reference/api/functions/exposed.enum/enumerations/ExposedFn","unlisted":false}]}],"href":"/docs/reference/api/functions/exposed.enum/"}]},{"type":"category","label":"api/model","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/model/aliases","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AccountNumber","href":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","docId":"reference/api/model/aliases/type-aliases/AccountNumber","unlisted":false},{"type":"link","label":"Type Alias: AdvancedFile","href":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","docId":"reference/api/model/aliases/type-aliases/AdvancedFile","unlisted":false},{"type":"link","label":"Type Alias: Base64","href":"/docs/reference/api/model/aliases/type-aliases/Base64","docId":"reference/api/model/aliases/type-aliases/Base64","unlisted":false},{"type":"link","label":"Type Alias: ChatId","href":"/docs/reference/api/model/aliases/type-aliases/ChatId","docId":"reference/api/model/aliases/type-aliases/ChatId","unlisted":false},{"type":"link","label":"Type Alias: ChatServer","href":"/docs/reference/api/model/aliases/type-aliases/ChatServer","docId":"reference/api/model/aliases/type-aliases/ChatServer","unlisted":false},{"type":"link","label":"Type Alias: ContactId","href":"/docs/reference/api/model/aliases/type-aliases/ContactId","docId":"reference/api/model/aliases/type-aliases/ContactId","unlisted":false},{"type":"link","label":"Type Alias: Content","href":"/docs/reference/api/model/aliases/type-aliases/Content","docId":"reference/api/model/aliases/type-aliases/Content","unlisted":false},{"type":"link","label":"Type Alias: CountryCode","href":"/docs/reference/api/model/aliases/type-aliases/CountryCode","docId":"reference/api/model/aliases/type-aliases/CountryCode","unlisted":false},{"type":"link","label":"Type Alias: DataURL","href":"/docs/reference/api/model/aliases/type-aliases/DataURL","docId":"reference/api/model/aliases/type-aliases/DataURL","unlisted":false},{"type":"link","label":"Type Alias: FilePath","href":"/docs/reference/api/model/aliases/type-aliases/FilePath","docId":"reference/api/model/aliases/type-aliases/FilePath","unlisted":false},{"type":"link","label":"Type Alias: GetURL","href":"/docs/reference/api/model/aliases/type-aliases/GetURL","docId":"reference/api/model/aliases/type-aliases/GetURL","unlisted":false},{"type":"link","label":"Type Alias: GroupChatId","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","docId":"reference/api/model/aliases/type-aliases/GroupChatId","unlisted":false},{"type":"link","label":"Type Alias: GroupChatServer","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","docId":"reference/api/model/aliases/type-aliases/GroupChatServer","unlisted":false},{"type":"link","label":"Type Alias: GroupId","href":"/docs/reference/api/model/aliases/type-aliases/GroupId","docId":"reference/api/model/aliases/type-aliases/GroupId","unlisted":false},{"type":"link","label":"Type Alias: MessageId","href":"/docs/reference/api/model/aliases/type-aliases/MessageId","docId":"reference/api/model/aliases/type-aliases/MessageId","unlisted":false},{"type":"link","label":"Type Alias: NonSerializedId","href":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","docId":"reference/api/model/aliases/type-aliases/NonSerializedId","unlisted":false},{"type":"link","label":"Type Alias: WaServers","href":"/docs/reference/api/model/aliases/type-aliases/WaServers","docId":"reference/api/model/aliases/type-aliases/WaServers","unlisted":false}]}],"href":"/docs/reference/api/model/aliases/"},{"type":"category","label":"api/model/button","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AdvancedButton","href":"/docs/reference/api/model/button/interfaces/AdvancedButton","docId":"reference/api/model/button/interfaces/AdvancedButton","unlisted":false},{"type":"link","label":"Interface: Button","href":"/docs/reference/api/model/button/interfaces/Button","docId":"reference/api/model/button/interfaces/Button","unlisted":false},{"type":"link","label":"Interface: LocationButtonBody","href":"/docs/reference/api/model/button/interfaces/LocationButtonBody","docId":"reference/api/model/button/interfaces/LocationButtonBody","unlisted":false},{"type":"link","label":"Interface: Row","href":"/docs/reference/api/model/button/interfaces/Row","docId":"reference/api/model/button/interfaces/Row","unlisted":false},{"type":"link","label":"Interface: Section","href":"/docs/reference/api/model/button/interfaces/Section","docId":"reference/api/model/button/interfaces/Section","unlisted":false}]}],"href":"/docs/reference/api/model/button/"},{"type":"category","label":"api/model/call","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CallState","href":"/docs/reference/api/model/call/enumerations/CallState","docId":"reference/api/model/call/enumerations/CallState","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Call","href":"/docs/reference/api/model/call/interfaces/Call","docId":"reference/api/model/call/interfaces/Call","unlisted":false}]}],"href":"/docs/reference/api/model/call/"},{"type":"category","label":"api/model/chat","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ChatMuteDuration","href":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","docId":"reference/api/model/chat/enumerations/ChatMuteDuration","unlisted":false},{"type":"link","label":"Enumeration: ChatState","href":"/docs/reference/api/model/chat/enumerations/ChatState","docId":"reference/api/model/chat/enumerations/ChatState","unlisted":false},{"type":"link","label":"Enumeration: ChatTypes","href":"/docs/reference/api/model/chat/enumerations/ChatTypes","docId":"reference/api/model/chat/enumerations/ChatTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BaseChat","href":"/docs/reference/api/model/chat/interfaces/BaseChat","docId":"reference/api/model/chat/interfaces/BaseChat","unlisted":false},{"type":"link","label":"Interface: GroupChat","href":"/docs/reference/api/model/chat/interfaces/GroupChat","docId":"reference/api/model/chat/interfaces/GroupChat","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationParticipantAddResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationResponse","unlisted":false},{"type":"link","label":"Interface: LiveLocationChangedEvent","href":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","docId":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","unlisted":false},{"type":"link","label":"Interface: SingleChat","href":"/docs/reference/api/model/chat/interfaces/SingleChat","docId":"reference/api/model/chat/interfaces/SingleChat","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Chat","href":"/docs/reference/api/model/chat/type-aliases/Chat","docId":"reference/api/model/chat/type-aliases/Chat","unlisted":false},{"type":"link","label":"Type Alias: EphemeralDuration","href":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","docId":"reference/api/model/chat/type-aliases/EphemeralDuration","unlisted":false}]}],"href":"/docs/reference/api/model/chat/"},{"type":"category","label":"api/model/config","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CLOUD\\\\_PROVIDERS","href":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","docId":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","unlisted":false},{"type":"link","label":"Enumeration: DIRECTORY\\\\_STRATEGY","href":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","docId":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","unlisted":false},{"type":"link","label":"Enumeration: LicenseType","href":"/docs/reference/api/model/config/enumerations/LicenseType","docId":"reference/api/model/config/enumerations/LicenseType","unlisted":false},{"type":"link","label":"Enumeration: NotificationLanguage","href":"/docs/reference/api/model/config/enumerations/NotificationLanguage","docId":"reference/api/model/config/enumerations/NotificationLanguage","unlisted":false},{"type":"link","label":"Enumeration: OnError","href":"/docs/reference/api/model/config/enumerations/OnError","docId":"reference/api/model/config/enumerations/OnError","unlisted":false},{"type":"link","label":"Enumeration: QRFormat","href":"/docs/reference/api/model/config/enumerations/QRFormat","docId":"reference/api/model/config/enumerations/QRFormat","unlisted":false},{"type":"link","label":"Enumeration: QRQuality","href":"/docs/reference/api/model/config/enumerations/QRQuality","docId":"reference/api/model/config/enumerations/QRQuality","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: ConfigObject","href":"/docs/reference/api/model/config/interfaces/ConfigObject","docId":"reference/api/model/config/interfaces/ConfigObject","unlisted":false},{"type":"link","label":"Interface: DevTools","href":"/docs/reference/api/model/config/interfaces/DevTools","docId":"reference/api/model/config/interfaces/DevTools","unlisted":false},{"type":"link","label":"Interface: EventPayload","href":"/docs/reference/api/model/config/interfaces/EventPayload","docId":"reference/api/model/config/interfaces/EventPayload","unlisted":false},{"type":"link","label":"Interface: ProxyServerCredentials","href":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","docId":"reference/api/model/config/interfaces/ProxyServerCredentials","unlisted":false},{"type":"link","label":"Interface: SessionData","href":"/docs/reference/api/model/config/interfaces/SessionData","docId":"reference/api/model/config/interfaces/SessionData","unlisted":false},{"type":"link","label":"Interface: Webhook","href":"/docs/reference/api/model/config/interfaces/Webhook","docId":"reference/api/model/config/interfaces/Webhook","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AdvancedConfig","href":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","docId":"reference/api/model/config/type-aliases/AdvancedConfig","unlisted":false}]}],"href":"/docs/reference/api/model/config/"},{"type":"category","label":"api/model/contact","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BizCategory","href":"/docs/reference/api/model/contact/interfaces/BizCategory","docId":"reference/api/model/contact/interfaces/BizCategory","unlisted":false},{"type":"link","label":"Interface: BizProfileOptions","href":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","docId":"reference/api/model/contact/interfaces/BizProfileOptions","unlisted":false},{"type":"link","label":"Interface: BusinessHours","href":"/docs/reference/api/model/contact/interfaces/BusinessHours","docId":"reference/api/model/contact/interfaces/BusinessHours","unlisted":false},{"type":"link","label":"Interface: BusinessProfile","href":"/docs/reference/api/model/contact/interfaces/BusinessProfile","docId":"reference/api/model/contact/interfaces/BusinessProfile","unlisted":false},{"type":"link","label":"Interface: Contact","href":"/docs/reference/api/model/contact/interfaces/Contact","docId":"reference/api/model/contact/interfaces/Contact","unlisted":false},{"type":"link","label":"Interface: NumberCheck","href":"/docs/reference/api/model/contact/interfaces/NumberCheck","docId":"reference/api/model/contact/interfaces/NumberCheck","unlisted":false}]}],"href":"/docs/reference/api/model/contact/"},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: Events","href":"/docs/reference/api/model/enumerations/Events","docId":"reference/api/model/enumerations/Events","unlisted":false},{"type":"link","label":"Enumeration: STATE","href":"/docs/reference/api/model/enumerations/STATE","docId":"reference/api/model/enumerations/STATE","unlisted":false},{"type":"link","label":"Enumeration: Status","href":"/docs/reference/api/model/enumerations/Status","docId":"reference/api/model/enumerations/Status","unlisted":false}]},{"type":"category","label":"api/model/errors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: AddParticipantError","href":"/docs/reference/api/model/errors/classes/AddParticipantError","docId":"reference/api/model/errors/classes/AddParticipantError","unlisted":false},{"type":"link","label":"Class: CustomError","href":"/docs/reference/api/model/errors/classes/CustomError","docId":"reference/api/model/errors/classes/CustomError","unlisted":false},{"type":"link","label":"Class: PageEvaluationTimeout","href":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","docId":"reference/api/model/errors/classes/PageEvaluationTimeout","unlisted":false},{"type":"link","label":"Class: SessionExpiredError","href":"/docs/reference/api/model/errors/classes/SessionExpiredError","docId":"reference/api/model/errors/classes/SessionExpiredError","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: AddParticipantErrorStatusCode","href":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","docId":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","unlisted":false},{"type":"link","label":"Enumeration: ERROR\\\\_NAME","href":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","docId":"reference/api/model/errors/enumerations/ERROR_NAME","unlisted":false}]}],"href":"/docs/reference/api/model/errors/"},{"type":"category","label":"api/model/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: SimpleListener","href":"/docs/reference/api/model/events/enumerations/SimpleListener","docId":"reference/api/model/events/enumerations/SimpleListener","unlisted":false}]}],"href":"/docs/reference/api/model/events/"},{"type":"category","label":"api/model/group-metadata","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: GroupNotificationTypes","href":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","docId":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","unlisted":false},{"type":"link","label":"Enumeration: groupChangeEvent","href":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","docId":"reference/api/model/group-metadata/enumerations/groupChangeEvent","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: GenericGroupChangeEvent","href":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","docId":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","unlisted":false},{"type":"link","label":"Interface: GroupMetadata","href":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","docId":"reference/api/model/group-metadata/interfaces/GroupMetadata","unlisted":false},{"type":"link","label":"Interface: NewCommunityGroup","href":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","docId":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","unlisted":false},{"type":"link","label":"Interface: Participant","href":"/docs/reference/api/model/group-metadata/interfaces/Participant","docId":"reference/api/model/group-metadata/interfaces/Participant","unlisted":false},{"type":"link","label":"Interface: ParticipantChangedEventModel","href":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","docId":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","unlisted":false}]}],"href":"/docs/reference/api/model/group-metadata/"},{"type":"category","label":"api/model/id","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Id","href":"/docs/reference/api/model/id/interfaces/Id","docId":"reference/api/model/id/interfaces/Id","unlisted":false}]}],"href":"/docs/reference/api/model/id/"},{"type":"category","label":"api/model/label","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Label","href":"/docs/reference/api/model/label/interfaces/Label","docId":"reference/api/model/label/interfaces/Label","unlisted":false}]}],"href":"/docs/reference/api/model/label/"},{"type":"category","label":"api/model/media","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Mp4StickerConversionProcessOptions","href":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","docId":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","unlisted":false},{"type":"link","label":"Type Alias: StickerMetadata","href":"/docs/reference/api/model/media/type-aliases/StickerMetadata","docId":"reference/api/model/media/type-aliases/StickerMetadata","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: defaultProcessOptions","href":"/docs/reference/api/model/media/variables/defaultProcessOptions","docId":"reference/api/model/media/variables/defaultProcessOptions","unlisted":false}]}],"href":"/docs/reference/api/model/media/"},{"type":"category","label":"api/model/message","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: MessageAck","href":"/docs/reference/api/model/message/enumerations/MessageAck","docId":"reference/api/model/message/enumerations/MessageAck","unlisted":false},{"type":"link","label":"Enumeration: MessageTypes","href":"/docs/reference/api/model/message/enumerations/MessageTypes","docId":"reference/api/model/message/enumerations/MessageTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Message","href":"/docs/reference/api/model/message/interfaces/Message","docId":"reference/api/model/message/interfaces/Message","unlisted":false},{"type":"link","label":"Interface: MessageInfo","href":"/docs/reference/api/model/message/interfaces/MessageInfo","docId":"reference/api/model/message/interfaces/MessageInfo","unlisted":false},{"type":"link","label":"Interface: MessageInfoInteraction","href":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","docId":"reference/api/model/message/interfaces/MessageInfoInteraction","unlisted":false},{"type":"link","label":"Interface: PollData","href":"/docs/reference/api/model/message/interfaces/PollData","docId":"reference/api/model/message/interfaces/PollData","unlisted":false},{"type":"link","label":"Interface: PollOption","href":"/docs/reference/api/model/message/interfaces/PollOption","docId":"reference/api/model/message/interfaces/PollOption","unlisted":false},{"type":"link","label":"Interface: PollVote","href":"/docs/reference/api/model/message/interfaces/PollVote","docId":"reference/api/model/message/interfaces/PollVote","unlisted":false},{"type":"link","label":"Interface: QuoteMap","href":"/docs/reference/api/model/message/interfaces/QuoteMap","docId":"reference/api/model/message/interfaces/QuoteMap","unlisted":false},{"type":"link","label":"Interface: ReactionSender","href":"/docs/reference/api/model/message/interfaces/ReactionSender","docId":"reference/api/model/message/interfaces/ReactionSender","unlisted":false}]}],"href":"/docs/reference/api/model/message/"},{"type":"category","label":"api/model/product","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CartItem","href":"/docs/reference/api/model/product/interfaces/CartItem","docId":"reference/api/model/product/interfaces/CartItem","unlisted":false},{"type":"link","label":"Interface: CustomProduct","href":"/docs/reference/api/model/product/interfaces/CustomProduct","docId":"reference/api/model/product/interfaces/CustomProduct","unlisted":false},{"type":"link","label":"Interface: Order","href":"/docs/reference/api/model/product/interfaces/Order","docId":"reference/api/model/product/interfaces/Order","unlisted":false},{"type":"link","label":"Interface: Product","href":"/docs/reference/api/model/product/interfaces/Product","docId":"reference/api/model/product/interfaces/Product","unlisted":false}]}],"href":"/docs/reference/api/model/product/"},{"type":"category","label":"api/model/reactions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Reaction","href":"/docs/reference/api/model/reactions/type-aliases/Reaction","docId":"reference/api/model/reactions/type-aliases/Reaction","unlisted":false},{"type":"link","label":"Type Alias: ReactionEvent","href":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","docId":"reference/api/model/reactions/type-aliases/ReactionEvent","unlisted":false},{"type":"link","label":"Type Alias: ReactionRecord","href":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","docId":"reference/api/model/reactions/type-aliases/ReactionRecord","unlisted":false}]}],"href":"/docs/reference/api/model/reactions/"},{"type":"category","label":"api/model/sessionInfo","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: HealthCheck","href":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","docId":"reference/api/model/sessionInfo/interfaces/HealthCheck","unlisted":false},{"type":"link","label":"Interface: SessionInfo","href":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","docId":"reference/api/model/sessionInfo/interfaces/SessionInfo","unlisted":false}]}],"href":"/docs/reference/api/model/sessionInfo/"},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: EasyApiResponse","href":"/docs/reference/api/model/type-aliases/EasyApiResponse","docId":"reference/api/model/type-aliases/EasyApiResponse","unlisted":false}]}],"href":"/docs/reference/api/model/"}]},{"type":"category","label":"controllers","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"controllers/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: ev","href":"/docs/reference/controllers/events/variables/ev","docId":"reference/controllers/events/variables/ev","unlisted":false}]}],"href":"/docs/reference/controllers/events/"},{"type":"link","label":"controllers/init\\\\_patch","href":"/docs/reference/controllers/init_patch/","docId":"reference/controllers/init_patch/index","unlisted":false},{"type":"category","label":"controllers/initializer","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: create()","href":"/docs/reference/controllers/initializer/functions/create","docId":"reference/controllers/initializer/functions/create","unlisted":false},{"type":"link","label":"Function: timeout()","href":"/docs/reference/controllers/initializer/functions/timeout","docId":"reference/controllers/initializer/functions/timeout","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: configWithCases","href":"/docs/reference/controllers/initializer/variables/configWithCases","docId":"reference/controllers/initializer/variables/configWithCases","unlisted":false},{"type":"link","label":"Variable: pkg","href":"/docs/reference/controllers/initializer/variables/pkg","docId":"reference/controllers/initializer/variables/pkg","unlisted":false},{"type":"link","label":"Variable: screenshot","href":"/docs/reference/controllers/initializer/variables/screenshot","docId":"reference/controllers/initializer/variables/screenshot","unlisted":false}]}],"href":"/docs/reference/controllers/initializer/"},{"type":"category","label":"controllers/patch\\\\_manager","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: earlyInjectionCheck()","href":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","docId":"reference/controllers/patch_manager/functions/earlyInjectionCheck","unlisted":false},{"type":"link","label":"Function: getAndInjectLicense()","href":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","docId":"reference/controllers/patch_manager/functions/getAndInjectLicense","unlisted":false}]}],"href":"/docs/reference/controllers/patch_manager/"}]},{"type":"category","label":"logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"logging/custom\\\\_transport","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: LogToEvTransport","href":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","docId":"reference/logging/custom_transport/classes/LogToEvTransport","unlisted":false},{"type":"link","label":"Class: NoOpTransport","href":"/docs/reference/logging/custom_transport/classes/NoOpTransport","docId":"reference/logging/custom_transport/classes/NoOpTransport","unlisted":false}]}],"href":"/docs/reference/logging/custom_transport/"},{"type":"category","label":"logging/logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: addRotateFileLogTransport()","href":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","docId":"reference/logging/logging/functions/addRotateFileLogTransport","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: ConfigLogTransport","href":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","docId":"reference/logging/logging/type-aliases/ConfigLogTransport","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: log","href":"/docs/reference/logging/logging/variables/log","docId":"reference/logging/logging/variables/log","unlisted":false}]}],"href":"/docs/reference/logging/logging/"}]},{"type":"category","label":"structures","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"structures/Collector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Collection\\\\","href":"/docs/reference/structures/Collector/classes/Collection","docId":"reference/structures/Collector/classes/Collection","unlisted":false},{"type":"link","label":"Class: Collector","href":"/docs/reference/structures/Collector/classes/Collector","docId":"reference/structures/Collector/classes/Collector","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AwaitMessagesOptions","href":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","docId":"reference/structures/Collector/interfaces/AwaitMessagesOptions","unlisted":false},{"type":"link","label":"Interface: CollectorOptions","href":"/docs/reference/structures/Collector/interfaces/CollectorOptions","docId":"reference/structures/Collector/interfaces/CollectorOptions","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CollectorFilter()\\\\","href":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","docId":"reference/structures/Collector/type-aliases/CollectorFilter","unlisted":false}]}],"href":"/docs/reference/structures/Collector/"},{"type":"category","label":"structures/Dialog","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ValidationType","href":"/docs/reference/structures/Dialog/enumerations/ValidationType","docId":"reference/structures/Dialog/enumerations/ValidationType","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CurrentDialogProps","href":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","docId":"reference/structures/Dialog/interfaces/CurrentDialogProps","unlisted":false},{"type":"link","label":"Interface: DialogButtons","href":"/docs/reference/structures/Dialog/interfaces/DialogButtons","docId":"reference/structures/Dialog/interfaces/DialogButtons","unlisted":false},{"type":"link","label":"Interface: DialogListMessageRow","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","docId":"reference/structures/Dialog/interfaces/DialogListMessageRow","unlisted":false},{"type":"link","label":"Interface: DialogListMessageSection","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","docId":"reference/structures/Dialog/interfaces/DialogListMessageSection","unlisted":false},{"type":"link","label":"Interface: DialogProperty","href":"/docs/reference/structures/Dialog/interfaces/DialogProperty","docId":"reference/structures/Dialog/interfaces/DialogProperty","unlisted":false},{"type":"link","label":"Interface: DialogState","href":"/docs/reference/structures/Dialog/interfaces/DialogState","docId":"reference/structures/Dialog/interfaces/DialogState","unlisted":false},{"type":"link","label":"Interface: DialogTemplate","href":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","docId":"reference/structures/Dialog/interfaces/DialogTemplate","unlisted":false},{"type":"link","label":"Interface: DialogValidation","href":"/docs/reference/structures/Dialog/interfaces/DialogValidation","docId":"reference/structures/Dialog/interfaces/DialogValidation","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CheckFunction()","href":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","docId":"reference/structures/Dialog/type-aliases/CheckFunction","unlisted":false}]}],"href":"/docs/reference/structures/Dialog/"},{"type":"category","label":"structures/MessageCollector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: MessageCollector","href":"/docs/reference/structures/MessageCollector/classes/MessageCollector","docId":"reference/structures/MessageCollector/classes/MessageCollector","unlisted":false}]}],"href":"/docs/reference/structures/MessageCollector/"},{"type":"category","label":"structures/preProcessors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: PREPROCESSORS","href":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","docId":"reference/structures/preProcessors/enumerations/PREPROCESSORS","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: MPConfigType","href":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","docId":"reference/structures/preProcessors/type-aliases/MPConfigType","unlisted":false},{"type":"link","label":"Type Alias: MessagePreProcessor()","href":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","docId":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: MessagePreprocessors","href":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","docId":"reference/structures/preProcessors/variables/MessagePreprocessors","unlisted":false}]}],"href":"/docs/reference/structures/preProcessors/"}]}],"href":"/docs/reference/"}]},"docs":{"advanced/best-practices":{"id":"advanced/best-practices","title":"Best Practice","description":"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@open-wa/wa-automate v4.71.15","description":"Modules","sidebar":"tutorialSidebar"},"concepts/glossary":{"id":"concepts/glossary","title":"Glossary of terms","description":"In order to get used to this project, you might find it useful to learn a few regularly used terms","sidebar":"tutorialSidebar"},"concepts/how-it-works":{"id":"concepts/how-it-works","title":"How does this work?","description":"wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the \\"Client\\". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.","sidebar":"tutorialSidebar"},"configuration/capture-qr":{"id":"configuration/capture-qr","title":"Capturing QR Code","description":"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.","sidebar":"tutorialSidebar"},"configuration/capture-sd":{"id":"configuration/capture-sd","title":"Capturing the session data","description":"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.","sidebar":"tutorialSidebar"},"configuration/command-line-options":{"id":"configuration/command-line-options","title":"EASY API CLI options","description":"Command-line options reference documentation.","sidebar":"tutorialSidebar"},"configuration/config-object":{"id":"configuration/config-object","title":"Configuration","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"configuration/launch-events":{"id":"configuration/launch-events","title":"Launch Events","description":"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:","sidebar":"tutorialSidebar"},"configuration/licensed-features":{"id":"configuration/licensed-features","title":"Licensed Features","description":"Features","sidebar":"tutorialSidebar"},"configuration/multiple-sessions":{"id":"configuration/multiple-sessions","title":"Multiple Sessions","description":"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:","sidebar":"tutorialSidebar"},"configuration/the-client":{"id":"configuration/the-client","title":"The Client","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"get-started/docker":{"id":"get-started/docker","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/installation":{"id":"get-started/installation","title":"Custom Code","description":"Standard Installation","sidebar":"tutorialSidebar"},"get-started/link-code":{"id":"get-started/link-code","title":"Logging in with a link code","description":"Simple docs showing how to use open-wa/wa-automate with a link code.","sidebar":"tutorialSidebar"},"get-started/quick-run":{"id":"get-started/quick-run","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket mode","description":"Guide showing how to develop your own solutions without needing to wait for session restarts.","sidebar":"tutorialSidebar"},"how-to/create-api":{"id":"how-to/create-api","title":"Creating an API","description":"There are multiple convinient ways to create an API.","sidebar":"tutorialSidebar"},"how-to/decrypt-media":{"id":"how-to/decrypt-media","title":"Decrypting Media","description":"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.","sidebar":"tutorialSidebar"},"how-to/detect-logout":{"id":"how-to/detect-logout","title":"Detecting Logouts","description":"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.","sidebar":"tutorialSidebar"},"how-to/groups":{"id":"how-to/groups","title":"Group","description":"Create a Group","sidebar":"tutorialSidebar"},"how-to/handle-errors":{"id":"how-to/handle-errors","title":"Error Handling","description":"Keep your promises!","sidebar":"tutorialSidebar"},"how-to/incoming-calls":{"id":"how-to/incoming-calls","title":"Handle Incoming Call","description":"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number","sidebar":"tutorialSidebar"},"how-to/location":{"id":"how-to/location","title":"Location","description":"Sending Location","sidebar":"tutorialSidebar"},"how-to/manage-participants":{"id":"how-to/manage-participants","title":"Manage Participants","description":"[[addParticipant]] - add a participant","sidebar":"tutorialSidebar"},"how-to/misc":{"id":"how-to/misc","title":"More examples","description":"Simulate typing","sidebar":"tutorialSidebar"},"how-to/react-to-group-events":{"id":"how-to/react-to-group-events","title":"Reacting To Group Events","description":"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).","sidebar":"tutorialSidebar"},"how-to/read-state":{"id":"how-to/read-state","title":"read-state","description":"","sidebar":"tutorialSidebar"},"how-to/receive-files":{"id":"how-to/receive-files","title":"receive-files","description":"","sidebar":"tutorialSidebar"},"how-to/receive-messages":{"id":"how-to/receive-messages","title":"Receiving Messages","description":"Listen to only incoming messages","sidebar":"tutorialSidebar"},"how-to/send-files":{"id":"how-to/send-files","title":"Sending Files","description":"Send Image","sidebar":"tutorialSidebar"},"how-to/send-messages":{"id":"how-to/send-messages","title":"Sending Messages","description":"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.","sidebar":"tutorialSidebar"},"how-to/send-videos":{"id":"how-to/send-videos","title":"Send Video","description":"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.","sidebar":"tutorialSidebar"},"how-to/sendfile":{"id":"how-to/sendfile","title":"SendFile","description":"","sidebar":"tutorialSidebar"},"how-to/use-a-proxy":{"id":"how-to/use-a-proxy","title":"Proxying your session","description":"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:","sidebar":"tutorialSidebar"},"Integrations/chatwoot":{"id":"Integrations/chatwoot","title":"Chatwoot integrations","description":"ready made integration for chatwoot.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.","sidebar":"tutorialSidebar"},"reference/api/Client/classes/Client":{"id":"reference/api/Client/classes/Client","title":"Class: Client","description":"Methods","sidebar":"tutorialSidebar"},"reference/api/Client/enumerations/namespace":{"id":"reference/api/Client/enumerations/namespace","title":"Enumeration: namespace","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/Client/index":{"id":"reference/api/Client/index","title":"api/Client","description":"Index","sidebar":"tutorialSidebar"},"reference/api/Client/variables/useragent":{"id":"reference/api/Client/variables/useragent","title":"Variable: useragent","description":"const useragent: string","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/enumerations/ExposedFn":{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","title":"Enumeration: ExposedFn","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/index":{"id":"reference/api/functions/exposed.enum/index","title":"api/functions/exposed.enum","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/index":{"id":"reference/api/model/aliases/index","title":"api/model/aliases","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AccountNumber":{"id":"reference/api/model/aliases/type-aliases/AccountNumber","title":"Type Alias: AccountNumber","description":"AccountNumber: \\\\$\\\\{number\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AdvancedFile":{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","title":"Type Alias: AdvancedFile","description":"AdvancedFile: DataURL \\\\| FilePath \\\\| GetURL","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Base64":{"id":"reference/api/model/aliases/type-aliases/Base64","title":"Type Alias: Base64","description":"Base64: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatId":{"id":"reference/api/model/aliases/type-aliases/ChatId","title":"Type Alias: ChatId","description":"ChatId: ContactId \\\\| GroupChatId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatServer":{"id":"reference/api/model/aliases/type-aliases/ChatServer","title":"Type Alias: ChatServer","description":"ChatServer: \\"c.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ContactId":{"id":"reference/api/model/aliases/type-aliases/ContactId","title":"Type Alias: ContactId","description":"ContactId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Content":{"id":"reference/api/model/aliases/type-aliases/Content","title":"Type Alias: Content","description":"Content: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/CountryCode":{"id":"reference/api/model/aliases/type-aliases/CountryCode","title":"Type Alias: CountryCode","description":"CountryCode: 1 \\\\| 7 \\\\| 20 \\\\| 27 \\\\| 30 \\\\| 31 \\\\| 32 \\\\| 33 \\\\| 34 \\\\| 36 \\\\| 39 \\\\| 40 \\\\| 41 \\\\| 43 \\\\| 44 \\\\| 45 \\\\| 46 \\\\| 47 \\\\| 48 \\\\| 49 \\\\| 51 \\\\| 52 \\\\| 53 \\\\| 54 \\\\| 55 \\\\| 56 \\\\| 57 \\\\| 58 \\\\| 60 \\\\| 61 \\\\| 62 \\\\| 63 \\\\| 64 \\\\| 65 \\\\| 66 \\\\| 81 \\\\| 82 \\\\| 84 \\\\| 86 \\\\| 90 \\\\| 91 \\\\| 92 \\\\| 93 \\\\| 94 \\\\| 95 \\\\| 98 \\\\| 211 \\\\| 212 \\\\| 213 \\\\| 216 \\\\| 218 \\\\| 220 \\\\| 221 \\\\| 222 \\\\| 223 \\\\| 224 \\\\| 225 \\\\| 226 \\\\| 227 \\\\| 228 \\\\| 229 \\\\| 230 \\\\| 231 \\\\| 232 \\\\| 233 \\\\| 234 \\\\| 235 \\\\| 236 \\\\| 237 \\\\| 238 \\\\| 239 \\\\| 240 \\\\| 241 \\\\| 242 \\\\| 243 \\\\| 244 \\\\| 245 \\\\| 246 \\\\| 248 \\\\| 249 \\\\| 250 \\\\| 251 \\\\| 252 \\\\| 253 \\\\| 254 \\\\| 255 \\\\| 256 \\\\| 257 \\\\| 258 \\\\| 260 \\\\| 261 \\\\| 262 \\\\| 263 \\\\| 264 \\\\| 265 \\\\| 266 \\\\| 267 \\\\| 268 \\\\| 269 \\\\| 290 \\\\| 291 \\\\| 297 \\\\| 298 \\\\| 299 \\\\| 350 \\\\| 351 \\\\| 352 \\\\| 353 \\\\| 354 \\\\| 355 \\\\| 356 \\\\| 357 \\\\| 358 \\\\| 359 \\\\| 370 \\\\| 371 \\\\| 372 \\\\| 373 \\\\| 374 \\\\| 375 \\\\| 376 \\\\| 377 \\\\| 378 \\\\| 380 \\\\| 381 \\\\| 382 \\\\| 383 \\\\| 385 \\\\| 386 \\\\| 387 \\\\| 389 \\\\| 420 \\\\| 421 \\\\| 423 \\\\| 500 \\\\| 501 \\\\| 502 \\\\| 503 \\\\| 504 \\\\| 505 \\\\| 506 \\\\| 507 \\\\| 508 \\\\| 509 \\\\| 590 \\\\| 591 \\\\| 592 \\\\| 593 \\\\| 594 \\\\| 595 \\\\| 596 \\\\| 597 \\\\| 598 \\\\| 599 \\\\| 670 \\\\| 672 \\\\| 673 \\\\| 674 \\\\| 675 \\\\| 676 \\\\| 677 \\\\| 678 \\\\| 679 \\\\| 680 \\\\| 681 \\\\| 682 \\\\| 683 \\\\| 685 \\\\| 686 \\\\| 687 \\\\| 688 \\\\| 689 \\\\| 690 \\\\| 691 \\\\| 692 \\\\| 850 \\\\| 852 \\\\| 853 \\\\| 855 \\\\| 856 \\\\| 880 \\\\| 886 \\\\| 960 \\\\| 961 \\\\| 962 \\\\| 963 \\\\| 964 \\\\| 965 \\\\| 966 \\\\| 967 \\\\| 968 \\\\| 970 \\\\| 971 \\\\| 972 \\\\| 973 \\\\| 974 \\\\| 975 \\\\| 976 \\\\| 977 \\\\| 992 \\\\| 993 \\\\| 994 \\\\| 995 \\\\| 996 \\\\| 998","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/DataURL":{"id":"reference/api/model/aliases/type-aliases/DataURL","title":"Type Alias: DataURL","description":"DataURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/FilePath":{"id":"reference/api/model/aliases/type-aliases/FilePath","title":"Type Alias: FilePath","description":"FilePath: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GetURL":{"id":"reference/api/model/aliases/type-aliases/GetURL","title":"Type Alias: GetURL","description":"GetURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatId":{"id":"reference/api/model/aliases/type-aliases/GroupChatId","title":"Type Alias: GroupChatId","description":"GroupChatId: \\\\$\\\\{AccountNumber\\\\}-$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\ \\\\| GroupId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatServer":{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","title":"Type Alias: GroupChatServer","description":"GroupChatServer: \\"g.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupId":{"id":"reference/api/model/aliases/type-aliases/GroupId","title":"Type Alias: GroupId","description":"GroupId: \\\\$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/MessageId":{"id":"reference/api/model/aliases/type-aliases/MessageId","title":"Type Alias: MessageId","description":"MessageId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/NonSerializedId":{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","title":"Type Alias: NonSerializedId","description":"NonSerializedId: object","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/WaServers":{"id":"reference/api/model/aliases/type-aliases/WaServers","title":"Type Alias: WaServers","description":"WaServers: ChatServer \\\\| GroupChatServer","sidebar":"tutorialSidebar"},"reference/api/model/button/index":{"id":"reference/api/model/button/index","title":"api/model/button","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/AdvancedButton":{"id":"reference/api/model/button/interfaces/AdvancedButton","title":"Interface: AdvancedButton","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Button":{"id":"reference/api/model/button/interfaces/Button","title":"Interface: Button","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/LocationButtonBody":{"id":"reference/api/model/button/interfaces/LocationButtonBody","title":"Interface: LocationButtonBody","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Row":{"id":"reference/api/model/button/interfaces/Row","title":"Interface: Row","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Section":{"id":"reference/api/model/button/interfaces/Section","title":"Interface: Section","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/call/enumerations/CallState":{"id":"reference/api/model/call/enumerations/CallState","title":"Enumeration: CallState","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/call/index":{"id":"reference/api/model/call/index","title":"api/model/call","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/call/interfaces/Call":{"id":"reference/api/model/call/interfaces/Call","title":"Interface: Call","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatMuteDuration":{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","title":"Enumeration: ChatMuteDuration","description":"Valid durations for muting a chat using [[muteChat]]","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatState":{"id":"reference/api/model/chat/enumerations/ChatState","title":"Enumeration: ChatState","description":"The ChatState represents the state you\'d normally see represented under the chat name in the app.","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatTypes":{"id":"reference/api/model/chat/enumerations/ChatTypes","title":"Enumeration: ChatTypes","description":"Chat types","sidebar":"tutorialSidebar"},"reference/api/model/chat/index":{"id":"reference/api/model/chat/index","title":"api/model/chat","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/BaseChat":{"id":"reference/api/model/chat/interfaces/BaseChat","title":"Interface: BaseChat","description":"Extended by","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChat":{"id":"reference/api/model/chat/interfaces/GroupChat","title":"Interface: GroupChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","title":"Interface: GroupChatCreationParticipantAddResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","title":"Interface: GroupChatCreationResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/LiveLocationChangedEvent":{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","title":"Interface: LiveLocationChangedEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/SingleChat":{"id":"reference/api/model/chat/interfaces/SingleChat","title":"Interface: SingleChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/Chat":{"id":"reference/api/model/chat/type-aliases/Chat","title":"Type Alias: Chat","description":"Chat: SingleChat \\\\| GroupChat","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/EphemeralDuration":{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","title":"Type Alias: EphemeralDuration","description":"EphemeralDuration: 86400 \\\\| 604800 \\\\| 7776000","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/CLOUD_PROVIDERS":{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","title":"Enumeration: CLOUD\\\\_PROVIDERS","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/DIRECTORY_STRATEGY":{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","title":"Enumeration: DIRECTORY\\\\_STRATEGY","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/LicenseType":{"id":"reference/api/model/config/enumerations/LicenseType","title":"Enumeration: LicenseType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/NotificationLanguage":{"id":"reference/api/model/config/enumerations/NotificationLanguage","title":"Enumeration: NotificationLanguage","description":"The available languages for the host security notification","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/OnError":{"id":"reference/api/model/config/enumerations/OnError","title":"Enumeration: OnError","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRFormat":{"id":"reference/api/model/config/enumerations/QRFormat","title":"Enumeration: QRFormat","description":"The different types of qr code output.","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRQuality":{"id":"reference/api/model/config/enumerations/QRQuality","title":"Enumeration: QRQuality","description":"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.","sidebar":"tutorialSidebar"},"reference/api/model/config/index":{"id":"reference/api/model/config/index","title":"api/model/config","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ConfigObject":{"id":"reference/api/model/config/interfaces/ConfigObject","title":"Interface: ConfigObject","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/DevTools":{"id":"reference/api/model/config/interfaces/DevTools","title":"Interface: DevTools","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/EventPayload":{"id":"reference/api/model/config/interfaces/EventPayload","title":"Interface: EventPayload","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ProxyServerCredentials":{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","title":"Interface: ProxyServerCredentials","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/SessionData":{"id":"reference/api/model/config/interfaces/SessionData","title":"Interface: SessionData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/Webhook":{"id":"reference/api/model/config/interfaces/Webhook","title":"Interface: Webhook","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/type-aliases/AdvancedConfig":{"id":"reference/api/model/config/type-aliases/AdvancedConfig","title":"Type Alias: AdvancedConfig","description":"AdvancedConfig: ConfigObject & object","sidebar":"tutorialSidebar"},"reference/api/model/contact/index":{"id":"reference/api/model/contact/index","title":"api/model/contact","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizCategory":{"id":"reference/api/model/contact/interfaces/BizCategory","title":"Interface: BizCategory","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizProfileOptions":{"id":"reference/api/model/contact/interfaces/BizProfileOptions","title":"Interface: BizProfileOptions","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessHours":{"id":"reference/api/model/contact/interfaces/BusinessHours","title":"Interface: BusinessHours","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessProfile":{"id":"reference/api/model/contact/interfaces/BusinessProfile","title":"Interface: BusinessProfile","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/Contact":{"id":"reference/api/model/contact/interfaces/Contact","title":"Interface: Contact","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/NumberCheck":{"id":"reference/api/model/contact/interfaces/NumberCheck","title":"Interface: NumberCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Events":{"id":"reference/api/model/enumerations/Events","title":"Enumeration: Events","description":"Events that can be emitted by the client","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/STATE":{"id":"reference/api/model/enumerations/STATE","title":"Enumeration: STATE","description":"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren\'t understood completely.","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Status":{"id":"reference/api/model/enumerations/Status","title":"Enumeration: Status","description":"Client status","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/AddParticipantError":{"id":"reference/api/model/errors/classes/AddParticipantError","title":"Class: AddParticipantError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/CustomError":{"id":"reference/api/model/errors/classes/CustomError","title":"Class: CustomError","description":"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/PageEvaluationTimeout":{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","title":"Class: PageEvaluationTimeout","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/SessionExpiredError":{"id":"reference/api/model/errors/classes/SessionExpiredError","title":"Class: SessionExpiredError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode":{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","title":"Enumeration: AddParticipantErrorStatusCode","description":"Add Participants Status Code Enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/ERROR_NAME":{"id":"reference/api/model/errors/enumerations/ERROR_NAME","title":"Enumeration: ERROR\\\\_NAME","description":"Enum of error names specific to this library","sidebar":"tutorialSidebar"},"reference/api/model/errors/index":{"id":"reference/api/model/errors/index","title":"api/model/errors","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/events/enumerations/SimpleListener":{"id":"reference/api/model/events/enumerations/SimpleListener","title":"Enumeration: SimpleListener","description":"An enum of all the \\"simple listeners\\". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.","sidebar":"tutorialSidebar"},"reference/api/model/events/index":{"id":"reference/api/model/events/index","title":"api/model/events","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/groupChangeEvent":{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","title":"Enumeration: groupChangeEvent","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/GroupNotificationTypes":{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","title":"Enumeration: GroupNotificationTypes","description":"Group notification types","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/index":{"id":"reference/api/model/group-metadata/index","title":"api/model/group-metadata","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent":{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","title":"Interface: GenericGroupChangeEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GroupMetadata":{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","title":"Interface: GroupMetadata","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/NewCommunityGroup":{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","title":"Interface: NewCommunityGroup","description":"Used when creating a new community with.","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/Participant":{"id":"reference/api/model/group-metadata/interfaces/Participant","title":"Interface: Participant","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel":{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","title":"Interface: ParticipantChangedEventModel","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/id/index":{"id":"reference/api/model/id/index","title":"api/model/id","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/id/interfaces/Id":{"id":"reference/api/model/id/interfaces/Id","title":"Interface: Id","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/index":{"id":"reference/api/model/index","title":"api/model","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/index":{"id":"reference/api/model/label/index","title":"api/model/label","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/interfaces/Label":{"id":"reference/api/model/label/interfaces/Label","title":"Interface: Label","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/media/index":{"id":"reference/api/model/media/index","title":"api/model/media","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions":{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","title":"Type Alias: Mp4StickerConversionProcessOptions","description":"Mp4StickerConversionProcessOptions: object","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/StickerMetadata":{"id":"reference/api/model/media/type-aliases/StickerMetadata","title":"Type Alias: StickerMetadata","description":"StickerMetadata: object","sidebar":"tutorialSidebar"},"reference/api/model/media/variables/defaultProcessOptions":{"id":"reference/api/model/media/variables/defaultProcessOptions","title":"Variable: defaultProcessOptions","description":"const defaultProcessOptions: Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageAck":{"id":"reference/api/model/message/enumerations/MessageAck","title":"Enumeration: MessageAck","description":"Message ACK","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageTypes":{"id":"reference/api/model/message/enumerations/MessageTypes","title":"Enumeration: MessageTypes","description":"Message types","sidebar":"tutorialSidebar"},"reference/api/model/message/index":{"id":"reference/api/model/message/index","title":"api/model/message","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/Message":{"id":"reference/api/model/message/interfaces/Message","title":"Interface: Message","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfo":{"id":"reference/api/model/message/interfaces/MessageInfo","title":"Interface: MessageInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfoInteraction":{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","title":"Interface: MessageInfoInteraction","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollData":{"id":"reference/api/model/message/interfaces/PollData","title":"Interface: PollData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollOption":{"id":"reference/api/model/message/interfaces/PollOption","title":"Interface: PollOption","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollVote":{"id":"reference/api/model/message/interfaces/PollVote","title":"Interface: PollVote","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/QuoteMap":{"id":"reference/api/model/message/interfaces/QuoteMap","title":"Interface: QuoteMap","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/ReactionSender":{"id":"reference/api/model/message/interfaces/ReactionSender","title":"Interface: ReactionSender","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/index":{"id":"reference/api/model/product/index","title":"api/model/product","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CartItem":{"id":"reference/api/model/product/interfaces/CartItem","title":"Interface: CartItem","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CustomProduct":{"id":"reference/api/model/product/interfaces/CustomProduct","title":"Interface: CustomProduct","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Order":{"id":"reference/api/model/product/interfaces/Order","title":"Interface: Order","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Product":{"id":"reference/api/model/product/interfaces/Product","title":"Interface: Product","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/reactions/index":{"id":"reference/api/model/reactions/index","title":"api/model/reactions","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/Reaction":{"id":"reference/api/model/reactions/type-aliases/Reaction","title":"Type Alias: Reaction","description":"Reaction: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionEvent":{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","title":"Type Alias: ReactionEvent","description":"ReactionEvent: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionRecord":{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","title":"Type Alias: ReactionRecord","description":"ReactionRecord: object","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/index":{"id":"reference/api/model/sessionInfo/index","title":"api/model/sessionInfo","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/HealthCheck":{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","title":"Interface: HealthCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/SessionInfo":{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","title":"Interface: SessionInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/type-aliases/EasyApiResponse":{"id":"reference/api/model/type-aliases/EasyApiResponse","title":"Type Alias: EasyApiResponse","description":"EasyApiResponse: object","sidebar":"tutorialSidebar"},"reference/controllers/events/index":{"id":"reference/controllers/events/index","title":"controllers/events","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/events/variables/ev":{"id":"reference/controllers/events/variables/ev","title":"Variable: ev","description":"const ev: EventEmitter2","sidebar":"tutorialSidebar"},"reference/controllers/init_patch/index":{"id":"reference/controllers/init_patch/index","title":"controllers/init\\\\_patch","description":"","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/create":{"id":"reference/controllers/initializer/functions/create","title":"Function: create()","description":"create(config): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/timeout":{"id":"reference/controllers/initializer/functions/timeout","title":"Function: timeout()","description":"timeout(ms): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/index":{"id":"reference/controllers/initializer/index","title":"controllers/initializer","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/configWithCases":{"id":"reference/controllers/initializer/variables/configWithCases","title":"Variable: configWithCases","description":"const configWithCases: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/pkg":{"id":"reference/controllers/initializer/variables/pkg","title":"Variable: pkg","description":"const pkg: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/screenshot":{"id":"reference/controllers/initializer/variables/screenshot","title":"Variable: screenshot","description":"screenshot: any","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/earlyInjectionCheck":{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","title":"Function: earlyInjectionCheck()","description":"earlyInjectionCheck(page): Promise\\\\ boolean\\\\>","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/getAndInjectLicense":{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","title":"Function: getAndInjectLicense()","description":"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/index":{"id":"reference/controllers/patch_manager/index","title":"controllers/patch\\\\_manager","description":"Index","sidebar":"tutorialSidebar"},"reference/index":{"id":"reference/index","title":"@open-wa/wa-automate v4.72.4","description":"Modules","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/LogToEvTransport":{"id":"reference/logging/custom_transport/classes/LogToEvTransport","title":"Class: LogToEvTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/NoOpTransport":{"id":"reference/logging/custom_transport/classes/NoOpTransport","title":"Class: NoOpTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/index":{"id":"reference/logging/custom_transport/index","title":"logging/custom\\\\_transport","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/functions/addRotateFileLogTransport":{"id":"reference/logging/logging/functions/addRotateFileLogTransport","title":"Function: addRotateFileLogTransport()","description":"addRotateFileLogTransport(options): void","sidebar":"tutorialSidebar"},"reference/logging/logging/index":{"id":"reference/logging/logging/index","title":"logging/logging","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/type-aliases/ConfigLogTransport":{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","title":"Type Alias: ConfigLogTransport","description":"ConfigLogTransport: object","sidebar":"tutorialSidebar"},"reference/logging/logging/variables/log":{"id":"reference/logging/logging/variables/log","title":"Variable: log","description":"const log: Logger","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collection":{"id":"reference/structures/Collector/classes/Collection","title":"Class: Collection\\\\","description":"Extends","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collector":{"id":"reference/structures/Collector/classes/Collector","title":"Class: Collector","description":"Abstract class for defining a new Collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/index":{"id":"reference/structures/Collector/index","title":"structures/Collector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/AwaitMessagesOptions":{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","title":"Interface: AwaitMessagesOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/CollectorOptions":{"id":"reference/structures/Collector/interfaces/CollectorOptions","title":"Interface: CollectorOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/type-aliases/CollectorFilter":{"id":"reference/structures/Collector/type-aliases/CollectorFilter","title":"Type Alias: CollectorFilter()\\\\","description":"CollectorFilter\\\\: (...args) => boolean \\\\| Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/Dialog/enumerations/ValidationType":{"id":"reference/structures/Dialog/enumerations/ValidationType","title":"Enumeration: ValidationType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/structures/Dialog/index":{"id":"reference/structures/Dialog/index","title":"structures/Dialog","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/CurrentDialogProps":{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","title":"Interface: CurrentDialogProps","description":"Indexable","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogButtons":{"id":"reference/structures/Dialog/interfaces/DialogButtons","title":"Interface: DialogButtons","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageRow":{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","title":"Interface: DialogListMessageRow","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageSection":{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","title":"Interface: DialogListMessageSection","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogProperty":{"id":"reference/structures/Dialog/interfaces/DialogProperty","title":"Interface: DialogProperty","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogState":{"id":"reference/structures/Dialog/interfaces/DialogState","title":"Interface: DialogState","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogTemplate":{"id":"reference/structures/Dialog/interfaces/DialogTemplate","title":"Interface: DialogTemplate","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogValidation":{"id":"reference/structures/Dialog/interfaces/DialogValidation","title":"Interface: DialogValidation","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/type-aliases/CheckFunction":{"id":"reference/structures/Dialog/type-aliases/CheckFunction","title":"Type Alias: CheckFunction()","description":"CheckFunction: (lastReceivedMessage, currentProps) => boolean","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/classes/MessageCollector":{"id":"reference/structures/MessageCollector/classes/MessageCollector","title":"Class: MessageCollector","description":"Collects messages on a chat.","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/index":{"id":"reference/structures/MessageCollector/index","title":"structures/MessageCollector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/enumerations/PREPROCESSORS":{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","title":"Enumeration: PREPROCESSORS","description":"A set of easy to use, built-in message processors.","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/index":{"id":"reference/structures/preProcessors/index","title":"structures/preProcessors","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MessagePreProcessor":{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","title":"Type Alias: MessagePreProcessor()","description":"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MPConfigType":{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","title":"Type Alias: MPConfigType","description":"MPConfigType: PREPROCESSORS \\\\| MessagePreProcessor \\\\| (PREPROCESSORS \\\\| MessagePreProcessor)[]","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/variables/MessagePreprocessors":{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","title":"Variable: MessagePreprocessors","description":"const MessagePreprocessors: object","sidebar":"tutorialSidebar"},"tutorial-basics/congratulations":{"id":"tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-blog-post":{"id":"tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-document":{"id":"tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-page":{"id":"tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"tutorialSidebar"},"tutorial-basics/deploy-your-site":{"id":"tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"tutorialSidebar"},"tutorial-basics/markdown-features":{"id":"tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"tutorialSidebar"},"tutorial-extras/manage-docs-versions":{"id":"tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"tutorialSidebar"},"tutorial-extras/translate-your-site":{"id":"tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/00c93e1e.24856d6e.js b/assets/js/00c93e1e.24856d6e.js new file mode 100644 index 0000000000..681ee7cc33 --- /dev/null +++ b/assets/js/00c93e1e.24856d6e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9837],{8397:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=s(4848),t=s(8453);const r={},i="Enumeration: ExposedFn",c={id:"reference/api/functions/exposed.enum/enumerations/ExposedFn",title:"Enumeration: ExposedFn",description:"Enumeration Members",source:"@site/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",sourceDirName:"reference/api/functions/exposed.enum/enumerations",slug:"/reference/api/functions/exposed.enum/enumerations/ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/functions/exposed.enum",permalink:"/docs/reference/api/functions/exposed.enum/"},next:{title:"api/model",permalink:"/docs/reference/api/model/"}},a={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"OnAnyMessage",id:"onanymessage",level:3},{value:"OnMessage",id:"onmessage",level:3},{value:"onAck",id:"onack",level:3},{value:"onParticipantsChanged",id:"onparticipantschanged",level:3},{value:"onStateChanged",id:"onstatechanged",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"enumeration-exposedfn",children:"Enumeration: ExposedFn"})}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"onanymessage",children:"OnAnyMessage"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"OnAnyMessage"}),": ",(0,o.jsx)(n.code,{children:'"onAnyMessage"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onmessage",children:"OnMessage"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"OnMessage"}),": ",(0,o.jsx)(n.code,{children:'"onMessage"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onack",children:"onAck"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onAck"}),": ",(0,o.jsx)(n.code,{children:'"onAck"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onparticipantschanged",children:"onParticipantsChanged"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onParticipantsChanged"}),": ",(0,o.jsx)(n.code,{children:'"onParticipantsChanged"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onStateChanged"}),": ",(0,o.jsx)(n.code,{children:'"onStateChanged"'})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var o=s(6540);const t={},r=o.createContext(t);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/00c93e1e.bcfaf7a8.js b/assets/js/00c93e1e.bcfaf7a8.js deleted file mode 100644 index 93dfe2b4c7..0000000000 --- a/assets/js/00c93e1e.bcfaf7a8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9837],{8397:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=s(4848),t=s(8453);const r={},i="Enumeration: ExposedFn",c={id:"reference/api/functions/exposed.enum/enumerations/ExposedFn",title:"Enumeration: ExposedFn",description:"Enumeration Members",source:"@site/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",sourceDirName:"reference/api/functions/exposed.enum/enumerations",slug:"/reference/api/functions/exposed.enum/enumerations/ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/functions/exposed.enum",permalink:"/docs/reference/api/functions/exposed.enum/"},next:{title:"api/model",permalink:"/docs/reference/api/model/"}},a={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"OnAnyMessage",id:"onanymessage",level:3},{value:"OnMessage",id:"onmessage",level:3},{value:"onAck",id:"onack",level:3},{value:"onParticipantsChanged",id:"onparticipantschanged",level:3},{value:"onStateChanged",id:"onstatechanged",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"enumeration-exposedfn",children:"Enumeration: ExposedFn"}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"onanymessage",children:"OnAnyMessage"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"OnAnyMessage"}),": ",(0,o.jsx)(n.code,{children:'"onAnyMessage"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onmessage",children:"OnMessage"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"OnMessage"}),": ",(0,o.jsx)(n.code,{children:'"onMessage"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onack",children:"onAck"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onAck"}),": ",(0,o.jsx)(n.code,{children:'"onAck"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onparticipantschanged",children:"onParticipantsChanged"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onParticipantsChanged"}),": ",(0,o.jsx)(n.code,{children:'"onParticipantsChanged"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"onStateChanged"}),": ",(0,o.jsx)(n.code,{children:'"onStateChanged"'})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var o=s(6540);const t={},r=o.createContext(t);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/00f29cf5.c01ecac6.js b/assets/js/00f29cf5.7a0dcdd3.js similarity index 51% rename from assets/js/00f29cf5.c01ecac6.js rename to assets/js/00f29cf5.7a0dcdd3.js index 1859dc87c1..874cc35602 100644 --- a/assets/js/00f29cf5.c01ecac6.js +++ b/assets/js/00f29cf5.7a0dcdd3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4424],{3999:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=r(4848),s=r(8453);const o={},l="controllers/events",c={id:"reference/controllers/events/index",title:"controllers/events",description:"Index",source:"@site/docs/reference/controllers/events/index.md",sourceDirName:"reference/controllers/events",slug:"/reference/controllers/events/",permalink:"/docs/reference/controllers/events/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/events/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse"},next:{title:"Variable: ev",permalink:"/docs/reference/controllers/events/variables/ev"}},i={},a=[{value:"Index",id:"index",level:2},{value:"Variables",id:"variables",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"controllersevents",children:"controllers/events"}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/events/variables/ev",children:"ev"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>c});var t=r(6540);const s={},o=t.createContext(s);function l(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4424],{3999:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=r(4848),s=r(8453);const o={},l="controllers/events",c={id:"reference/controllers/events/index",title:"controllers/events",description:"Index",source:"@site/docs/reference/controllers/events/index.md",sourceDirName:"reference/controllers/events",slug:"/reference/controllers/events/",permalink:"/docs/reference/controllers/events/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/events/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse"},next:{title:"Variable: ev",permalink:"/docs/reference/controllers/events/variables/ev"}},i={},a=[{value:"Index",id:"index",level:2},{value:"Variables",id:"variables",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"controllersevents",children:"controllers/events"})}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/events/variables/ev",children:"ev"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>c});var t=r(6540);const s={},o=t.createContext(s);function l(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01a85c17.00604f63.js b/assets/js/01a85c17.00604f63.js deleted file mode 100644 index 0052a8ebda..0000000000 --- a/assets/js/01a85c17.00604f63.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8209],{6535:(e,s,t)=>{t.d(s,{A:()=>v});var a=t(6540),i=t(4164),r=t(9201),l=t(4581),n=t(8774),c=t(1312),o=t(6347),d=t(9169);function m(e){const{pathname:s}=(0,o.zy)();return(0,a.useMemo)((()=>e.filter((e=>function(e,s){return!(e.unlisted&&!(0,d.ys)(e.permalink,s))}(e,s)))),[e,s])}const u={sidebar:"sidebar_re4s",sidebarItemTitle:"sidebarItemTitle_pO2u",sidebarItemList:"sidebarItemList_Yudw",sidebarItem:"sidebarItem__DBe",sidebarItemLink:"sidebarItemLink_mo7H",sidebarItemLinkActive:"sidebarItemLinkActive_I1ZP"};var b=t(4848);function g(e){let{sidebar:s}=e;const t=m(s.items);return(0,b.jsx)("aside",{className:"col col--3",children:(0,b.jsxs)("nav",{className:(0,i.A)(u.sidebar,"thin-scrollbar"),"aria-label":(0,c.T)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"}),children:[(0,b.jsx)("div",{className:(0,i.A)(u.sidebarItemTitle,"margin-bottom--md"),children:s.title}),(0,b.jsx)("ul",{className:(0,i.A)(u.sidebarItemList,"clean-list"),children:t.map((e=>(0,b.jsx)("li",{className:u.sidebarItem,children:(0,b.jsx)(n.A,{isNavLink:!0,to:e.permalink,className:u.sidebarItemLink,activeClassName:u.sidebarItemLinkActive,children:e.title})},e.permalink)))})]})})}var h=t(5600);function j(e){let{sidebar:s}=e;const t=m(s.items);return(0,b.jsx)("ul",{className:"menu__list",children:t.map((e=>(0,b.jsx)("li",{className:"menu__list-item",children:(0,b.jsx)(n.A,{isNavLink:!0,to:e.permalink,className:"menu__link",activeClassName:"menu__link--active",children:e.title})},e.permalink)))})}function p(e){return(0,b.jsx)(h.GX,{component:j,props:e})}function x(e){let{sidebar:s}=e;const t=(0,l.l)();return s?.items.length?"mobile"===t?(0,b.jsx)(p,{sidebar:s}):(0,b.jsx)(g,{sidebar:s}):null}function v(e){const{sidebar:s,toc:t,children:a,...l}=e,n=s&&s.items.length>0;return(0,b.jsx)(r.A,{...l,children:(0,b.jsx)("div",{className:"container margin-vert--lg",children:(0,b.jsxs)("div",{className:"row",children:[(0,b.jsx)(x,{sidebar:s}),(0,b.jsx)("main",{className:(0,i.A)("col",{"col--7":n,"col--9 col--offset-1":!n}),children:a}),t&&(0,b.jsx)("div",{className:"col col--2",children:t})]})})})}},9158:(e,s,t)=>{t.r(s),t.d(s,{default:()=>j});t(6540);var a=t(4164),i=t(1312);const r=()=>(0,i.T)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});var l=t(5500),n=t(7559),c=t(6535),o=t(6133),d=t(1107);const m={tag:"tag_Nnez"};var u=t(4848);function b(e){let{letterEntry:s}=e;return(0,u.jsxs)("article",{children:[(0,u.jsx)(d.A,{as:"h2",id:s.letter,children:s.letter}),(0,u.jsx)("ul",{className:"padding--none",children:s.tags.map((e=>(0,u.jsx)("li",{className:m.tag,children:(0,u.jsx)(o.A,{...e})},e.permalink)))}),(0,u.jsx)("hr",{})]})}function g(e){let{tags:s}=e;const t=function(e){const s={};return Object.values(e).forEach((e=>{const t=function(e){return e[0].toUpperCase()}(e.label);s[t]??=[],s[t].push(e)})),Object.entries(s).sort(((e,s)=>{let[t]=e,[a]=s;return t.localeCompare(a)})).map((e=>{let[s,t]=e;return{letter:s,tags:t.sort(((e,s)=>e.label.localeCompare(s.label)))}}))}(s);return(0,u.jsx)("section",{className:"margin-vert--lg",children:t.map((e=>(0,u.jsx)(b,{letterEntry:e},e.letter)))})}var h=t(1463);function j(e){let{tags:s,sidebar:t}=e;const i=r();return(0,u.jsxs)(l.e3,{className:(0,a.A)(n.G.wrapper.blogPages,n.G.page.blogTagsListPage),children:[(0,u.jsx)(l.be,{title:i}),(0,u.jsx)(h.A,{tag:"blog_tags_list"}),(0,u.jsxs)(c.A,{sidebar:t,children:[(0,u.jsx)(d.A,{as:"h1",children:i}),(0,u.jsx)(g,{tags:s})]})]})}},6133:(e,s,t)=>{t.d(s,{A:()=>n});t(6540);var a=t(4164),i=t(8774);const r={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var l=t(4848);function n(e){let{permalink:s,label:t,count:n,description:c}=e;return(0,l.jsxs)(i.A,{href:s,title:c,className:(0,a.A)(r.tag,n?r.tagWithCount:r.tagRegular),children:[t,n&&(0,l.jsx)("span",{children:n})]})}}}]); \ No newline at end of file diff --git a/assets/js/01a85c17.c9b7e3d3.js b/assets/js/01a85c17.c9b7e3d3.js new file mode 100644 index 0000000000..b83c38bd0c --- /dev/null +++ b/assets/js/01a85c17.c9b7e3d3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8209],{4096:(e,t,a)=>{a.d(t,{in:()=>c,OU:()=>P,Ki:()=>A,kJ:()=>b,x:()=>l,e7:()=>m,J_:()=>f,Gx:()=>y});var s=a(6540),n=a(9532),i=a(6803),r=a(4848);function l(){const e=(0,i.A)(),t=e?.data?.blogMetadata;if(!t)throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");return t}const o=s.createContext(null);function c(e){let{children:t,content:a,isBlogPostPage:n=!1}=e;const i=function(e){let{content:t,isBlogPostPage:a}=e;return(0,s.useMemo)((()=>({metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,toc:t.toc,isBlogPostPage:a})),[t,a])}({content:a,isBlogPostPage:n});return(0,r.jsx)(o.Provider,{value:i,children:t})}function m(){const e=(0,s.useContext)(o);if(null===e)throw new n.dV("BlogPostProvider");return e}var d=a(6025),u=a(4586);const g=e=>new Date(e).toISOString();function h(e){const t=e.map(x);return{author:1===t.length?t[0]:t}}function p(e,t,a){return e?{image:j({imageUrl:t(e,{absolute:!0}),caption:`title image for the blog post: ${a}`})}:{}}function b(e){const{siteConfig:t}=(0,u.A)(),{withBaseUrl:a}=(0,d.hH)(),{metadata:{blogDescription:s,blogTitle:n,permalink:i}}=e,r=`${t.url}${i}`;return{"@context":"https://schema.org","@type":"Blog","@id":r,mainEntityOfPage:r,headline:n,description:s,blogPost:e.items.map((e=>function(e,t,a){const{assets:s,frontMatter:n,metadata:i}=e,{date:r,title:l,description:o,lastUpdatedAt:c}=i,m=s.image??n.image,d=n.keywords??[],u=`${t.url}${i.permalink}`,b=c?g(c):void 0;return{"@type":"BlogPosting","@id":u,mainEntityOfPage:u,url:u,headline:l,name:l,description:o,datePublished:r,...b?{dateModified:b}:{},...h(i.authors),...p(m,a,l),...d?{keywords:d}:{}}}(e.content,t,a)))}}function f(){const e=l(),{assets:t,metadata:a}=m(),{siteConfig:s}=(0,u.A)(),{withBaseUrl:n}=(0,d.hH)(),{date:i,title:r,description:o,frontMatter:c,lastUpdatedAt:b}=a,f=t.image??c.image,x=c.keywords??[],j=b?g(b):void 0,N=`${s.url}${a.permalink}`;return{"@context":"https://schema.org","@type":"BlogPosting","@id":N,mainEntityOfPage:N,url:N,headline:r,name:r,description:o,datePublished:i,...j?{dateModified:j}:{},...h(a.authors),...p(f,n,r),...x?{keywords:x}:{},isPartOf:{"@type":"Blog","@id":`${s.url}${e.blogBasePath}`,name:e.blogTitle}}}function x(e){return{"@type":"Person",...e.name?{name:e.name}:{},...e.title?{description:e.title}:{},...e.url?{url:e.url}:{},...e.email?{email:e.email}:{},...e.imageURL?{image:e.imageURL}:{}}}function j(e){let{imageUrl:t,caption:a}=e;return{"@type":"ImageObject","@id":t,url:t,contentUrl:t,caption:a}}var N=a(6347),v=a(8774),C=a(1682),k=a(9169);function y(e){const{pathname:t}=(0,N.zy)();return(0,s.useMemo)((()=>e.filter((e=>function(e,t){return!(e.unlisted&&!(0,k.ys)(e.permalink,t))}(e,t)))),[e,t])}function A(e){const t=(0,C.$z)(e,(e=>`${new Date(e.date).getFullYear()}`)),a=Object.entries(t);return a.reverse(),a}function P(e){let{items:t,ulClassName:a,liClassName:s,linkClassName:n,linkActiveClassName:i}=e;return(0,r.jsx)("ul",{className:a,children:t.map((e=>(0,r.jsx)("li",{className:s,children:(0,r.jsx)(v.A,{isNavLink:!0,to:e.permalink,className:n,activeClassName:i,children:e.title})},e.permalink)))})}},8027:(e,t,a)=>{a.d(t,{A:()=>O});var s=a(6540),n=a(4164),i=a(3277),r=a(4581),l=a(1312),o=a(4096),c=a(6342),m=a(1107),d=a(4848);function u(e){let{year:t,yearGroupHeadingClassName:a,children:s}=e;return(0,d.jsxs)("div",{role:"group",children:[(0,d.jsx)(m.A,{as:"h3",className:a,children:t}),s]})}function g(e){let{items:t,yearGroupHeadingClassName:a,ListComponent:s}=e;if((0,c.p)().blog.sidebar.groupByYear){const e=(0,o.Ki)(t);return(0,d.jsx)(d.Fragment,{children:e.map((e=>{let[t,n]=e;return(0,d.jsx)(u,{year:t,yearGroupHeadingClassName:a,children:(0,d.jsx)(s,{items:n})},t)}))})}return(0,d.jsx)(s,{items:t})}const h=(0,s.memo)(g),p="sidebar_re4s",b="sidebarItemTitle_pO2u",f="sidebarItemList_Yudw",x="sidebarItem__DBe",j="sidebarItemLink_mo7H",N="sidebarItemLinkActive_I1ZP",v="yearGroupHeading_rMGB",C=e=>{let{items:t}=e;return(0,d.jsx)(o.OU,{items:t,ulClassName:(0,n.A)(f,"clean-list"),liClassName:x,linkClassName:j,linkActiveClassName:N})};function k(e){let{sidebar:t}=e;const a=(0,o.Gx)(t.items);return(0,d.jsx)("aside",{className:"col col--3",children:(0,d.jsxs)("nav",{className:(0,n.A)(p,"thin-scrollbar"),"aria-label":(0,l.T)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"}),children:[(0,d.jsx)("div",{className:(0,n.A)(b,"margin-bottom--md"),children:t.title}),(0,d.jsx)(h,{items:a,ListComponent:C,yearGroupHeadingClassName:v})]})})}const y=(0,s.memo)(k);var A=a(5600);const P={yearGroupHeading:"yearGroupHeading_QT03"},_=e=>{let{items:t}=e;return(0,d.jsx)(o.OU,{items:t,ulClassName:"menu__list",liClassName:"menu__list-item",linkClassName:"menu__link",linkActiveClassName:"menu__link--active"})};function w(e){let{sidebar:t}=e;const a=(0,o.Gx)(t.items);return(0,d.jsx)(h,{items:a,ListComponent:_,yearGroupHeadingClassName:P.yearGroupHeading})}function B(e){return(0,d.jsx)(A.GX,{component:w,props:e})}const G=(0,s.memo)(B);function H(e){let{sidebar:t}=e;const a=(0,r.l)();return t?.items.length?"mobile"===a?(0,d.jsx)(G,{sidebar:t}):(0,d.jsx)(y,{sidebar:t}):null}function O(e){const{sidebar:t,toc:a,children:s,...r}=e,l=t&&t.items.length>0;return(0,d.jsx)(i.A,{...r,children:(0,d.jsx)("div",{className:"container margin-vert--lg",children:(0,d.jsxs)("div",{className:"row",children:[(0,d.jsx)(H,{sidebar:t}),(0,d.jsx)("main",{className:(0,n.A)("col",{"col--7":l,"col--9 col--offset-1":!l}),children:s}),a&&(0,d.jsx)("div",{className:"col col--2",children:a})]})})})}},9158:(e,t,a)=>{a.r(t),a.d(t,{default:()=>b});a(6540);var s=a(4164),n=a(1312);const i=()=>(0,n.T)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});var r=a(5500),l=a(7559),o=a(8027),c=a(6133),m=a(1107);const d={tag:"tag_Nnez"};var u=a(4848);function g(e){let{letterEntry:t}=e;return(0,u.jsxs)("article",{children:[(0,u.jsx)(m.A,{as:"h2",id:t.letter,children:t.letter}),(0,u.jsx)("ul",{className:"padding--none",children:t.tags.map((e=>(0,u.jsx)("li",{className:d.tag,children:(0,u.jsx)(c.A,{...e})},e.permalink)))}),(0,u.jsx)("hr",{})]})}function h(e){let{tags:t}=e;const a=function(e){const t={};return Object.values(e).forEach((e=>{const a=function(e){return e[0].toUpperCase()}(e.label);t[a]??=[],t[a].push(e)})),Object.entries(t).sort(((e,t)=>{let[a]=e,[s]=t;return a.localeCompare(s)})).map((e=>{let[t,a]=e;return{letter:t,tags:a.sort(((e,t)=>e.label.localeCompare(t.label)))}}))}(t);return(0,u.jsx)("section",{className:"margin-vert--lg",children:a.map((e=>(0,u.jsx)(g,{letterEntry:e},e.letter)))})}var p=a(1463);function b(e){let{tags:t,sidebar:a}=e;const n=i();return(0,u.jsxs)(r.e3,{className:(0,s.A)(l.G.wrapper.blogPages,l.G.page.blogTagsListPage),children:[(0,u.jsx)(r.be,{title:n}),(0,u.jsx)(p.A,{tag:"blog_tags_list"}),(0,u.jsxs)(o.A,{sidebar:a,children:[(0,u.jsx)(m.A,{as:"h1",children:n}),(0,u.jsx)(h,{tags:t})]})]})}},6133:(e,t,a)=>{a.d(t,{A:()=>l});a(6540);var s=a(4164),n=a(8774);const i={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var r=a(4848);function l(e){let{permalink:t,label:a,count:l,description:o}=e;return(0,r.jsxs)(n.A,{href:t,title:o,className:(0,s.A)(i.tag,l?i.tagWithCount:i.tagRegular),children:[a,l&&(0,r.jsx)("span",{children:l})]})}}}]); \ No newline at end of file diff --git a/assets/js/0274794e.c86b9371.js b/assets/js/0274794e.c86b9371.js new file mode 100644 index 0000000000..413656f3c2 --- /dev/null +++ b/assets/js/0274794e.c86b9371.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6377],{1494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var s=i(4848),r=i(8453);const t={},a="api/Client",l={id:"reference/api/Client/index",title:"api/Client",description:"Index",source:"@site/docs/reference/api/Client/index.md",sourceDirName:"reference/api/Client",slug:"/reference/api/Client/",permalink:"/docs/reference/api/Client/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.72.4",permalink:"/docs/reference/"},next:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"}},c={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Variables",id:"variables",level:3}];function o(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"apiclient",children:"api/Client"})}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:"namespace"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:"Client"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/variables/useragent",children:"useragent"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(6540);const r={},t=s.createContext(r);function a(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0274794e.e3f53717.js b/assets/js/0274794e.e3f53717.js deleted file mode 100644 index 3c2983967e..0000000000 --- a/assets/js/0274794e.e3f53717.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6377],{1494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var s=i(4848),t=i(8453);const r={},a="api/Client",l={id:"reference/api/Client/index",title:"api/Client",description:"Index",source:"@site/docs/reference/api/Client/index.md",sourceDirName:"reference/api/Client",slug:"/reference/api/Client/",permalink:"/docs/reference/api/Client/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.72.3",permalink:"/docs/reference/"},next:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"}},c={},o=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Variables",id:"variables",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"apiclient",children:"api/Client"}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:"namespace"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:"Client"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/variables/useragent",children:"useragent"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(6540);const t={},r=s.createContext(t);function a(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/037298f3.7553f4a9.js b/assets/js/037298f3.7553f4a9.js new file mode 100644 index 0000000000..74b74cae2b --- /dev/null +++ b/assets/js/037298f3.7553f4a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1865],{6200:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>a,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var i=r(4848),d=r(8453);const c={},s="Interface: Product",l={id:"reference/api/model/product/interfaces/Product",title:"Interface: Product",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/Product.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/Product",permalink:"/docs/reference/api/model/product/interfaces/Product",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/Product.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Order",permalink:"/docs/reference/api/model/product/interfaces/Order"},next:{title:"api/model/reactions",permalink:"/docs/reference/api/model/reactions/"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"additionalImageCdnUrl?",id:"additionalimagecdnurl",level:3},{value:"availability?",id:"availability",level:3},{value:"Default",id:"default",level:4},{value:"catalogWid?",id:"catalogwid",level:3},{value:"currency",id:"currency",level:3},{value:"description?",id:"description",level:3},{value:"id",id:"id",level:3},{value:"imageCdnUrl?",id:"imagecdnurl",level:3},{value:"imageCount?",id:"imagecount",level:3},{value:"isHidden?",id:"ishidden",level:3},{value:"name?",id:"name",level:3},{value:"priceAmount1000?",id:"priceamount1000",level:3},{value:"retailerId?",id:"retailerid",level:3},{value:"reviewStatus?",id:"reviewstatus",level:3},{value:"t?",id:"t",level:3},{value:"url?",id:"url",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-product",children:"Interface: Product"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"additionalimagecdnurl",children:"additionalImageCdnUrl?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"additionalImageCdnUrl"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Array of URLs of the other images of the product. Does not include the main image."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"availability",children:"availability?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"availability"}),": ",(0,i.jsx)(n.code,{children:"number"})," | ",(0,i.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The availiable quantity of this product."}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'"unknown"`\n'})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"catalogwid",children:"catalogWid?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"catalogWid"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the catalog in which this product is located."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"currency",children:"currency"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"currency"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,i.jsx)(n.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,i.jsx)(n.code,{children:"SEK"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The description of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Product ID"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imagecdnurl",children:"imageCdnUrl?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"imageCdnUrl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The url of the main image of the product."}),"\n",(0,i.jsx)(n.p,{children:"NOTE: If downloading manually, the filetype must be changed to .jpg to view the image."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imagecount",children:"imageCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"imageCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of images of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ishidden",children:"isHidden?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isHidden"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the product is hidden from public view."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priceamount1000",children:"priceAmount1000?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"priceAmount1000"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The price of the product in 1000 units."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"retailerid",children:"retailerId?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"retailerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The custom id of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reviewstatus",children:"reviewStatus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"reviewStatus"}),": ",(0,i.jsx)(n.code,{children:'"REJECTED"'})," | ",(0,i.jsx)(n.code,{children:'"NO_REVIEW"'})," | ",(0,i.jsx)(n.code,{children:'"PENDING"'})," | ",(0,i.jsx)(n.code,{children:'"APPROVED"'})," | ",(0,i.jsx)(n.code,{children:'"OUTDATED"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The review status of the product"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp when the product was created / 1000"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"url",children:"url?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"url"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The URL of the product."})]})}function a(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var i=r(6540);const d={},c=i.createContext(d);function s(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/037298f3.830e839f.js b/assets/js/037298f3.830e839f.js deleted file mode 100644 index b538df8424..0000000000 --- a/assets/js/037298f3.830e839f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1865],{6200:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>a,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var i=r(4848),d=r(8453);const c={},s="Interface: Product",l={id:"reference/api/model/product/interfaces/Product",title:"Interface: Product",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/Product.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/Product",permalink:"/docs/reference/api/model/product/interfaces/Product",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/Product.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Order",permalink:"/docs/reference/api/model/product/interfaces/Order"},next:{title:"api/model/reactions",permalink:"/docs/reference/api/model/reactions/"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"additionalImageCdnUrl?",id:"additionalimagecdnurl",level:3},{value:"availability?",id:"availability",level:3},{value:"Default",id:"default",level:4},{value:"catalogWid?",id:"catalogwid",level:3},{value:"currency",id:"currency",level:3},{value:"description?",id:"description",level:3},{value:"id",id:"id",level:3},{value:"imageCdnUrl?",id:"imagecdnurl",level:3},{value:"imageCount?",id:"imagecount",level:3},{value:"isHidden?",id:"ishidden",level:3},{value:"name?",id:"name",level:3},{value:"priceAmount1000?",id:"priceamount1000",level:3},{value:"retailerId?",id:"retailerid",level:3},{value:"reviewStatus?",id:"reviewstatus",level:3},{value:"t?",id:"t",level:3},{value:"url?",id:"url",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-product",children:"Interface: Product"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"additionalimagecdnurl",children:"additionalImageCdnUrl?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"additionalImageCdnUrl"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Array of URLs of the other images of the product. Does not include the main image."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"availability",children:"availability?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"availability"}),": ",(0,i.jsx)(n.code,{children:"number"})," | ",(0,i.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The availiable quantity of this product."}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'"unknown"`\n'})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"catalogwid",children:"catalogWid?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"catalogWid"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the catalog in which this product is located."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"currency",children:"currency"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"currency"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,i.jsx)(n.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,i.jsx)(n.code,{children:"SEK"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The description of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Product ID"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imagecdnurl",children:"imageCdnUrl?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"imageCdnUrl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The url of the main image of the product."}),"\n",(0,i.jsx)(n.p,{children:"NOTE: If downloading manually, the filetype must be changed to .jpg to view the image."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imagecount",children:"imageCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"imageCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of images of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ishidden",children:"isHidden?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isHidden"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the product is hidden from public view."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priceamount1000",children:"priceAmount1000?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"priceAmount1000"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The price of the product in 1000 units."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"retailerid",children:"retailerId?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"retailerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The custom id of the product."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reviewstatus",children:"reviewStatus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"reviewStatus"}),": ",(0,i.jsx)(n.code,{children:'"REJECTED"'})," | ",(0,i.jsx)(n.code,{children:'"NO_REVIEW"'})," | ",(0,i.jsx)(n.code,{children:'"PENDING"'})," | ",(0,i.jsx)(n.code,{children:'"APPROVED"'})," | ",(0,i.jsx)(n.code,{children:'"OUTDATED"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The review status of the product"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp when the product was created / 1000"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"url",children:"url?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"url"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The URL of the product."})]})}function a(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var i=r(6540);const d={},c=i.createContext(d);function s(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0523356b.a82a6874.js b/assets/js/0523356b.a82a6874.js deleted file mode 100644 index 34616fad76..0000000000 --- a/assets/js/0523356b.a82a6874.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9571],{362:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>o,frontMatter:()=>s,metadata:()=>h,toc:()=>l});var i=r(4848),d=r(8453);const s={},c="Interface: SingleChat",h={id:"reference/api/model/chat/interfaces/SingleChat",title:"Interface: SingleChat",description:"Extends",source:"@site/docs/reference/api/model/chat/interfaces/SingleChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/SingleChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent"},next:{title:"Type Alias: Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat"}},a={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"archive",id:"archive",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"canSend?",id:"cansend",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"contact",id:"contact",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"id",id:"id",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"isGroup",id:"isgroup",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"kind",id:"kind",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"labels",id:"labels",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"msgs",id:"msgs",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"notSpam",id:"notspam",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"pic?",id:"pic",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"pin",id:"pin",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"presence",id:"presence",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"t",id:"t",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"unreadCount",id:"unreadcount",level:3},{value:"Inherited from",id:"inherited-from-25",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-singlechat",children:"Interface: SingleChat"}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#ack",children:(0,i.jsx)(n.code,{children:"ack"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#archive",children:(0,i.jsx)(n.code,{children:"archive"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#cansend",children:(0,i.jsx)(n.code,{children:"canSend"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumbernewjid",children:(0,i.jsx)(n.code,{children:"changeNumberNewJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumberoldjid",children:(0,i.jsx)(n.code,{children:"changeNumberOldJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#contact",children:(0,i.jsx)(n.code,{children:"contact"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#formattedtitle",children:(0,i.jsx)(n.code,{children:"formattedTitle"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#groupmetadata",children:(0,i.jsx)(n.code,{children:"groupMetadata"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isannouncegrprestrict",children:(0,i.jsx)(n.code,{children:"isAnnounceGrpRestrict"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isGroup"}),": ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isonline",children:(0,i.jsx)(n.code,{children:"isOnline"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isreadonly",children:(0,i.jsx)(n.code,{children:"isReadOnly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#kind",children:(0,i.jsx)(n.code,{children:"kind"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#labels",children:(0,i.jsx)(n.code,{children:"labels"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastreceivedkey",children:(0,i.jsx)(n.code,{children:"lastReceivedKey"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastseen",children:(0,i.jsx)(n.code,{children:"lastSeen"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#modifytag",children:(0,i.jsx)(n.code,{children:"modifyTag"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#msgs",children:(0,i.jsx)(n.code,{children:"msgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#muteexpiration",children:(0,i.jsx)(n.code,{children:"muteExpiration"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#name",children:(0,i.jsx)(n.code,{children:"name"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#notspam",children:(0,i.jsx)(n.code,{children:"notSpam"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pendingmsgs",children:(0,i.jsx)(n.code,{children:"pendingMsgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pic",children:(0,i.jsx)(n.code,{children:"pic"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pin",children:(0,i.jsx)(n.code,{children:"pin"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#presence",children:(0,i.jsx)(n.code,{children:"presence"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#t",children:(0,i.jsx)(n.code,{children:"t"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#unreadcount",children:(0,i.jsx)(n.code,{children:"unreadCount"})})]})]})}function o(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>h});var i=r(6540);const d={},s=i.createContext(d);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function h(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0523356b.db81533b.js b/assets/js/0523356b.db81533b.js new file mode 100644 index 0000000000..d948dedc8a --- /dev/null +++ b/assets/js/0523356b.db81533b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9571],{362:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>o,frontMatter:()=>s,metadata:()=>h,toc:()=>l});var i=r(4848),d=r(8453);const s={},c="Interface: SingleChat",h={id:"reference/api/model/chat/interfaces/SingleChat",title:"Interface: SingleChat",description:"Extends",source:"@site/docs/reference/api/model/chat/interfaces/SingleChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/SingleChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent"},next:{title:"Type Alias: Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat"}},a={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"archive",id:"archive",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"canSend?",id:"cansend",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"contact",id:"contact",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"id",id:"id",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"isGroup",id:"isgroup",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"kind",id:"kind",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"labels",id:"labels",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"msgs",id:"msgs",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"notSpam",id:"notspam",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"pic?",id:"pic",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"pin",id:"pin",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"presence",id:"presence",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"t",id:"t",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"unreadCount",id:"unreadcount",level:3},{value:"Inherited from",id:"inherited-from-25",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-singlechat",children:"Interface: SingleChat"})}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#ack",children:(0,i.jsx)(n.code,{children:"ack"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#archive",children:(0,i.jsx)(n.code,{children:"archive"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#cansend",children:(0,i.jsx)(n.code,{children:"canSend"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumbernewjid",children:(0,i.jsx)(n.code,{children:"changeNumberNewJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumberoldjid",children:(0,i.jsx)(n.code,{children:"changeNumberOldJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#contact",children:(0,i.jsx)(n.code,{children:"contact"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#formattedtitle",children:(0,i.jsx)(n.code,{children:"formattedTitle"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#groupmetadata",children:(0,i.jsx)(n.code,{children:"groupMetadata"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isannouncegrprestrict",children:(0,i.jsx)(n.code,{children:"isAnnounceGrpRestrict"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isGroup"}),": ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isonline",children:(0,i.jsx)(n.code,{children:"isOnline"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isreadonly",children:(0,i.jsx)(n.code,{children:"isReadOnly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#kind",children:(0,i.jsx)(n.code,{children:"kind"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#labels",children:(0,i.jsx)(n.code,{children:"labels"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastreceivedkey",children:(0,i.jsx)(n.code,{children:"lastReceivedKey"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastseen",children:(0,i.jsx)(n.code,{children:"lastSeen"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#modifytag",children:(0,i.jsx)(n.code,{children:"modifyTag"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#msgs",children:(0,i.jsx)(n.code,{children:"msgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#muteexpiration",children:(0,i.jsx)(n.code,{children:"muteExpiration"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#name",children:(0,i.jsx)(n.code,{children:"name"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#notspam",children:(0,i.jsx)(n.code,{children:"notSpam"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pendingmsgs",children:(0,i.jsx)(n.code,{children:"pendingMsgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pic",children:(0,i.jsx)(n.code,{children:"pic"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pin",children:(0,i.jsx)(n.code,{children:"pin"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#presence",children:(0,i.jsx)(n.code,{children:"presence"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#t",children:(0,i.jsx)(n.code,{children:"t"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#unreadcount",children:(0,i.jsx)(n.code,{children:"unreadCount"})})]})]})}function o(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>h});var i=r(6540);const d={},s=i.createContext(d);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function h(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0673617b.be678f10.js b/assets/js/0673617b.be678f10.js deleted file mode 100644 index 8bb2e031dd..0000000000 --- a/assets/js/0673617b.be678f10.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1543],{5010:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>d,metadata:()=>c,toc:()=>s});var i=t(4848),r=t(8453);const d={},a="api/model/id",c={id:"reference/api/model/id/index",title:"api/model/id",description:"Index",source:"@site/docs/reference/api/model/id/index.md",sourceDirName:"reference/api/model/id",slug:"/reference/api/model/id/",permalink:"/docs/reference/api/model/id/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/id/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel"},next:{title:"Interface: Id",permalink:"/docs/reference/api/model/id/interfaces/Id"}},o={},s=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"apimodelid",children:"api/model/id"}),"\n",(0,i.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:"Id"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var i=t(6540);const r={},d=i.createContext(r);function a(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0673617b.ee9cc9b2.js b/assets/js/0673617b.ee9cc9b2.js new file mode 100644 index 0000000000..0632ecd5c2 --- /dev/null +++ b/assets/js/0673617b.ee9cc9b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1543],{5010:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>d,metadata:()=>c,toc:()=>s});var r=t(4848),i=t(8453);const d={},a="api/model/id",c={id:"reference/api/model/id/index",title:"api/model/id",description:"Index",source:"@site/docs/reference/api/model/id/index.md",sourceDirName:"reference/api/model/id",slug:"/reference/api/model/id/",permalink:"/docs/reference/api/model/id/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/id/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel"},next:{title:"Interface: Id",permalink:"/docs/reference/api/model/id/interfaces/Id"}},o={},s=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelid",children:"api/model/id"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:"Id"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var r=t(6540);const i={},d=r.createContext(i);function a(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0730592b.4ac101ff.js b/assets/js/0730592b.4ac101ff.js new file mode 100644 index 0000000000..ab3a3e6c16 --- /dev/null +++ b/assets/js/0730592b.4ac101ff.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2419],{7094:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var t=n(4848),i=n(8453);const s={},o="Variable: pkg",c={id:"reference/controllers/initializer/variables/pkg",title:"Variable: pkg",description:"const pkg: any",source:"@site/docs/reference/controllers/initializer/variables/pkg.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/pkg.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases"},next:{title:"Variable: screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot"}},a={},l=[];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"variable-pkg",children:"Variable: pkg"})}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"const"})," ",(0,t.jsx)(r.strong,{children:"pkg"}),": ",(0,t.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>c});var t=n(6540);const i={},s=t.createContext(i);function o(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0730592b.f0bdaa67.js b/assets/js/0730592b.f0bdaa67.js deleted file mode 100644 index 0bcd8dcdd0..0000000000 --- a/assets/js/0730592b.f0bdaa67.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2419],{7094:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=n(4848),i=n(8453);const o={},s="Variable: pkg",c={id:"reference/controllers/initializer/variables/pkg",title:"Variable: pkg",description:"const pkg: any",source:"@site/docs/reference/controllers/initializer/variables/pkg.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/pkg.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases"},next:{title:"Variable: screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot"}},a={},l=[];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"variable-pkg",children:"Variable: pkg"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"const"})," ",(0,t.jsx)(r.strong,{children:"pkg"}),": ",(0,t.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>s,x:()=>c});var t=n(6540);const i={},o=t.createContext(i);function s(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/081c0950.57f463bf.js b/assets/js/081c0950.57f463bf.js new file mode 100644 index 0000000000..fc24a1fe4e --- /dev/null +++ b/assets/js/081c0950.57f463bf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5029],{9995:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>a,frontMatter:()=>i,metadata:()=>o,toc:()=>t});var r=s(4848),c=s(8453);const i={},d="Enumeration: MessageTypes",o={id:"reference/api/model/message/enumerations/MessageTypes",title:"Enumeration: MessageTypes",description:"Message types",source:"@site/docs/reference/api/model/message/enumerations/MessageTypes.md",sourceDirName:"reference/api/model/message/enumerations",slug:"/reference/api/model/message/enumerations/MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/enumerations/MessageTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"},next:{title:"Interface: Message",permalink:"/docs/reference/api/model/message/interfaces/Message"}},l={},t=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUDIO",id:"audio",level:3},{value:"BUTTONS_RESPONSE",id:"buttons_response",level:3},{value:"CONTACT_CARD",id:"contact_card",level:3},{value:"CONTACT_CARD_MULTI",id:"contact_card_multi",level:3},{value:"DOCUMENT",id:"document",level:3},{value:"IMAGE",id:"image",level:3},{value:"LIST_RESPONSE",id:"list_response",level:3},{value:"LOCATION",id:"location",level:3},{value:"ORDER",id:"order",level:3},{value:"REVOKED",id:"revoked",level:3},{value:"STICKER",id:"sticker",level:3},{value:"TEXT",id:"text",level:3},{value:"UNKNOWN",id:"unknown",level:3},{value:"VIDEO",id:"video",level:3},{value:"VOICE",id:"voice",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-messagetypes",children:"Enumeration: MessageTypes"})}),"\n",(0,r.jsx)(n.p,{children:"Message types"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"audio",children:"AUDIO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUDIO"}),": ",(0,r.jsx)(n.code,{children:'"audio"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"buttons_response",children:"BUTTONS_RESPONSE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"BUTTONS_RESPONSE"}),": ",(0,r.jsx)(n.code,{children:'"buttons_response"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact_card",children:"CONTACT_CARD"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONTACT_CARD"}),": ",(0,r.jsx)(n.code,{children:'"vcard"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact_card_multi",children:"CONTACT_CARD_MULTI"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONTACT_CARD_MULTI"}),": ",(0,r.jsx)(n.code,{children:'"multi_vcard"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"document",children:"DOCUMENT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DOCUMENT"}),": ",(0,r.jsx)(n.code,{children:'"document"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"image",children:"IMAGE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IMAGE"}),": ",(0,r.jsx)(n.code,{children:'"image"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"list_response",children:"LIST_RESPONSE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"LIST_RESPONSE"}),": ",(0,r.jsx)(n.code,{children:'"list_response"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"location",children:"LOCATION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"LOCATION"}),": ",(0,r.jsx)(n.code,{children:'"location"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"order",children:"ORDER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ORDER"}),": ",(0,r.jsx)(n.code,{children:'"order"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"revoked",children:"REVOKED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REVOKED"}),": ",(0,r.jsx)(n.code,{children:'"revoked"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sticker",children:"STICKER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"STICKER"}),": ",(0,r.jsx)(n.code,{children:'"sticker"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"text",children:"TEXT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TEXT"}),": ",(0,r.jsx)(n.code,{children:'"chat"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unknown",children:"UNKNOWN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNKNOWN"}),": ",(0,r.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"video",children:"VIDEO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"VIDEO"}),": ",(0,r.jsx)(n.code,{children:'"video"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"voice",children:"VOICE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"VOICE"}),": ",(0,r.jsx)(n.code,{children:'"ptt"'})]}),"\n"]})]})}function a(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var r=s(6540);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/081c0950.f69d5813.js b/assets/js/081c0950.f69d5813.js deleted file mode 100644 index a8415552ff..0000000000 --- a/assets/js/081c0950.f69d5813.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5029],{9995:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>a,frontMatter:()=>i,metadata:()=>o,toc:()=>t});var r=s(4848),c=s(8453);const i={},d="Enumeration: MessageTypes",o={id:"reference/api/model/message/enumerations/MessageTypes",title:"Enumeration: MessageTypes",description:"Message types",source:"@site/docs/reference/api/model/message/enumerations/MessageTypes.md",sourceDirName:"reference/api/model/message/enumerations",slug:"/reference/api/model/message/enumerations/MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/enumerations/MessageTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"},next:{title:"Interface: Message",permalink:"/docs/reference/api/model/message/interfaces/Message"}},l={},t=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUDIO",id:"audio",level:3},{value:"BUTTONS_RESPONSE",id:"buttons_response",level:3},{value:"CONTACT_CARD",id:"contact_card",level:3},{value:"CONTACT_CARD_MULTI",id:"contact_card_multi",level:3},{value:"DOCUMENT",id:"document",level:3},{value:"IMAGE",id:"image",level:3},{value:"LIST_RESPONSE",id:"list_response",level:3},{value:"LOCATION",id:"location",level:3},{value:"ORDER",id:"order",level:3},{value:"REVOKED",id:"revoked",level:3},{value:"STICKER",id:"sticker",level:3},{value:"TEXT",id:"text",level:3},{value:"UNKNOWN",id:"unknown",level:3},{value:"VIDEO",id:"video",level:3},{value:"VOICE",id:"voice",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-messagetypes",children:"Enumeration: MessageTypes"}),"\n",(0,r.jsx)(n.p,{children:"Message types"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"audio",children:"AUDIO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUDIO"}),": ",(0,r.jsx)(n.code,{children:'"audio"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"buttons_response",children:"BUTTONS_RESPONSE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"BUTTONS_RESPONSE"}),": ",(0,r.jsx)(n.code,{children:'"buttons_response"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact_card",children:"CONTACT_CARD"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONTACT_CARD"}),": ",(0,r.jsx)(n.code,{children:'"vcard"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact_card_multi",children:"CONTACT_CARD_MULTI"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONTACT_CARD_MULTI"}),": ",(0,r.jsx)(n.code,{children:'"multi_vcard"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"document",children:"DOCUMENT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DOCUMENT"}),": ",(0,r.jsx)(n.code,{children:'"document"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"image",children:"IMAGE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IMAGE"}),": ",(0,r.jsx)(n.code,{children:'"image"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"list_response",children:"LIST_RESPONSE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"LIST_RESPONSE"}),": ",(0,r.jsx)(n.code,{children:'"list_response"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"location",children:"LOCATION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"LOCATION"}),": ",(0,r.jsx)(n.code,{children:'"location"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"order",children:"ORDER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ORDER"}),": ",(0,r.jsx)(n.code,{children:'"order"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"revoked",children:"REVOKED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REVOKED"}),": ",(0,r.jsx)(n.code,{children:'"revoked"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sticker",children:"STICKER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"STICKER"}),": ",(0,r.jsx)(n.code,{children:'"sticker"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"text",children:"TEXT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TEXT"}),": ",(0,r.jsx)(n.code,{children:'"chat"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unknown",children:"UNKNOWN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNKNOWN"}),": ",(0,r.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"video",children:"VIDEO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"VIDEO"}),": ",(0,r.jsx)(n.code,{children:'"video"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"voice",children:"VOICE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"VOICE"}),": ",(0,r.jsx)(n.code,{children:'"ptt"'})]}),"\n"]})]})}function a(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var r=s(6540);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/099caee3.374cc4e2.js b/assets/js/099caee3.374cc4e2.js new file mode 100644 index 0000000000..da0353650f --- /dev/null +++ b/assets/js/099caee3.374cc4e2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4508],{4870:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var s=t(4848),n=t(8453);const r={},o="Type Alias: DataURL",i={id:"reference/api/model/aliases/type-aliases/DataURL",title:"Type Alias: DataURL",description:"DataURL: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/DataURL.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/DataURL.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode"},next:{title:"Type Alias: FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath"}},l={},c=[];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.header,{children:(0,s.jsx)(a.h1,{id:"type-alias-dataurl",children:"Type Alias: DataURL"})}),"\n",(0,s.jsxs)(a.blockquote,{children:["\n",(0,s.jsxs)(a.p,{children:[(0,s.jsx)(a.strong,{children:"DataURL"}),": ",(0,s.jsx)(a.code,{children:"Brand"}),"<`data:${string};base64,${Base64}`, ",(0,s.jsx)(a.code,{children:'"DataURL"'}),">"]}),"\n"]}),"\n",(0,s.jsx)(a.p,{children:'Data URLs, URLs prefixed with the data: scheme, allow content creators to embed small files inline in documents. They were formerly known as "data URIs" until that name was retired by the WHATWG.'}),"\n",(0,s.jsx)(a.p,{children:"Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself:"}),"\n",(0,s.jsxs)(a.p,{children:["Example:\n",(0,s.jsx)(a.code,{children:'"data:[][;base64],"'})]}),"\n",(0,s.jsxs)(a.p,{children:["Learn more here: ",(0,s.jsx)(a.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs",children:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"})]})]})}function p(e={}){const{wrapper:a}={...(0,n.R)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,a,t)=>{t.d(a,{R:()=>o,x:()=>i});var s=t(6540);const n={},r=s.createContext(n);function o(e){const a=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),s.createElement(r.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/099caee3.3dacec0d.js b/assets/js/099caee3.3dacec0d.js deleted file mode 100644 index 89f4691ebc..0000000000 --- a/assets/js/099caee3.3dacec0d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4508],{4870:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var s=t(4848),n=t(8453);const r={},o="Type Alias: DataURL",i={id:"reference/api/model/aliases/type-aliases/DataURL",title:"Type Alias: DataURL",description:"DataURL: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/DataURL.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/DataURL.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode"},next:{title:"Type Alias: FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath"}},l={},c=[];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.h1,{id:"type-alias-dataurl",children:"Type Alias: DataURL"}),"\n",(0,s.jsxs)(a.blockquote,{children:["\n",(0,s.jsxs)(a.p,{children:[(0,s.jsx)(a.strong,{children:"DataURL"}),": ",(0,s.jsx)(a.code,{children:"Brand"}),"<`data:${string};base64,${Base64}`, ",(0,s.jsx)(a.code,{children:'"DataURL"'}),">"]}),"\n"]}),"\n",(0,s.jsx)(a.p,{children:'Data URLs, URLs prefixed with the data: scheme, allow content creators to embed small files inline in documents. They were formerly known as "data URIs" until that name was retired by the WHATWG.'}),"\n",(0,s.jsx)(a.p,{children:"Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself:"}),"\n",(0,s.jsxs)(a.p,{children:["Example:\n",(0,s.jsx)(a.code,{children:'"data:[][;base64],"'})]}),"\n",(0,s.jsxs)(a.p,{children:["Learn more here: ",(0,s.jsx)(a.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs",children:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"})]})]})}function p(e={}){const{wrapper:a}={...(0,n.R)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,a,t)=>{t.d(a,{R:()=>o,x:()=>i});var s=t(6540);const n={},r=s.createContext(n);function o(e){const a=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),s.createElement(r.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0a59a0e8.7467bd19.js b/assets/js/0a59a0e8.7467bd19.js deleted file mode 100644 index 6f424f66e0..0000000000 --- a/assets/js/0a59a0e8.7467bd19.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9544],{7499:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var r=n(4848),i=n(8453);const o={},s="Function: timeout()",c={id:"reference/controllers/initializer/functions/timeout",title:"Function: timeout()",description:"timeout(ms): Promise\\",source:"@site/docs/reference/controllers/initializer/functions/timeout.md",sourceDirName:"reference/controllers/initializer/functions",slug:"/reference/controllers/initializer/functions/timeout",permalink:"/docs/reference/controllers/initializer/functions/timeout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/functions/timeout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: create()",permalink:"/docs/reference/controllers/initializer/functions/create"},next:{title:"Variable: configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases"}},l={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function a(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"function-timeout",children:"Function: timeout()"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"timeout"}),"(",(0,r.jsx)(t.code,{children:"ms"}),"): ",(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"ms"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"string"}),">"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0a59a0e8.b4ded237.js b/assets/js/0a59a0e8.b4ded237.js new file mode 100644 index 0000000000..503d8da40d --- /dev/null +++ b/assets/js/0a59a0e8.b4ded237.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9544],{7499:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var r=n(4848),i=n(8453);const o={},s="Function: timeout()",c={id:"reference/controllers/initializer/functions/timeout",title:"Function: timeout()",description:"timeout(ms): Promise\\",source:"@site/docs/reference/controllers/initializer/functions/timeout.md",sourceDirName:"reference/controllers/initializer/functions",slug:"/reference/controllers/initializer/functions/timeout",permalink:"/docs/reference/controllers/initializer/functions/timeout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/functions/timeout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: create()",permalink:"/docs/reference/controllers/initializer/functions/create"},next:{title:"Variable: configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases"}},l={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function a(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"function-timeout",children:"Function: timeout()"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"timeout"}),"(",(0,r.jsx)(t.code,{children:"ms"}),"): ",(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"ms"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"string"}),">"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0b9397d6.2a4792f0.js b/assets/js/0b9397d6.2a4792f0.js deleted file mode 100644 index af6ecaf0bd..0000000000 --- a/assets/js/0b9397d6.2a4792f0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3755],{5165:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=t(4848),a=t(8453);const s={},o="Enumeration: ChatState",i={id:"reference/api/model/chat/enumerations/ChatState",title:"Enumeration: ChatState",description:"The ChatState represents the state you'd normally see represented under the chat name in the app.",source:"@site/docs/reference/api/model/chat/enumerations/ChatState.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration"},next:{title:"Enumeration: ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"PAUSED",id:"paused",level:3},{value:"RECORDING",id:"recording",level:3},{value:"TYPING",id:"typing",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-chatstate",children:"Enumeration: ChatState"}),"\n",(0,r.jsx)(n.p,{children:"The ChatState represents the state you'd normally see represented under the chat name in the app."}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"paused",children:"PAUSED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PAUSED"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"online"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"recording",children:"RECORDING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"RECORDING"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"recording audio..."})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"typing",children:"TYPING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TYPING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"typing..."})})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>i});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0b9397d6.e34a1d30.js b/assets/js/0b9397d6.e34a1d30.js new file mode 100644 index 0000000000..4844bfe112 --- /dev/null +++ b/assets/js/0b9397d6.e34a1d30.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3755],{5165:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=t(4848),a=t(8453);const s={},o="Enumeration: ChatState",i={id:"reference/api/model/chat/enumerations/ChatState",title:"Enumeration: ChatState",description:"The ChatState represents the state you'd normally see represented under the chat name in the app.",source:"@site/docs/reference/api/model/chat/enumerations/ChatState.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration"},next:{title:"Enumeration: ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"PAUSED",id:"paused",level:3},{value:"RECORDING",id:"recording",level:3},{value:"TYPING",id:"typing",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-chatstate",children:"Enumeration: ChatState"})}),"\n",(0,r.jsx)(n.p,{children:"The ChatState represents the state you'd normally see represented under the chat name in the app."}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"paused",children:"PAUSED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PAUSED"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"online"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"recording",children:"RECORDING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"RECORDING"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"recording audio..."})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"typing",children:"TYPING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TYPING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"typing..."})})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>i});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0bf84b24.2959e6cc.js b/assets/js/0bf84b24.2959e6cc.js new file mode 100644 index 0000000000..70534d0b8b --- /dev/null +++ b/assets/js/0bf84b24.2959e6cc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6403],{9909:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(4848),c=s(8453);const t={},i="Interface: NumberCheck",o={id:"reference/api/model/contact/interfaces/NumberCheck",title:"Interface: NumberCheck",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/NumberCheck.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/NumberCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact"},next:{title:"Enumeration: Events",permalink:"/docs/reference/api/model/enumerations/Events"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"canReceiveMessage",id:"canreceivemessage",level:3},{value:"id",id:"id",level:3},{value:"isBusiness",id:"isbusiness",level:3},{value:"numberExists",id:"numberexists",level:3},{value:"status",id:"status",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-numbercheck",children:"Interface: NumberCheck"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"canreceivemessage",children:"canReceiveMessage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"canReceiveMessage"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:(0,r.jsx)(n.code,{children:"Id"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isbusiness",children:"isBusiness"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isBusiness"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"numberexists",children:"numberExists"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"numberExists"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"200"})," | ",(0,r.jsx)(n.code,{children:"404"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>o});var r=s(6540);const c={},t=r.createContext(c);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0bf84b24.f3a053bb.js b/assets/js/0bf84b24.f3a053bb.js deleted file mode 100644 index 6abb047562..0000000000 --- a/assets/js/0bf84b24.f3a053bb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6403],{9909:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(4848),c=s(8453);const t={},i="Interface: NumberCheck",o={id:"reference/api/model/contact/interfaces/NumberCheck",title:"Interface: NumberCheck",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/NumberCheck.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/NumberCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact"},next:{title:"Enumeration: Events",permalink:"/docs/reference/api/model/enumerations/Events"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"canReceiveMessage",id:"canreceivemessage",level:3},{value:"id",id:"id",level:3},{value:"isBusiness",id:"isbusiness",level:3},{value:"numberExists",id:"numberexists",level:3},{value:"status",id:"status",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-numbercheck",children:"Interface: NumberCheck"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"canreceivemessage",children:"canReceiveMessage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"canReceiveMessage"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:(0,r.jsx)(n.code,{children:"Id"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isbusiness",children:"isBusiness"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isBusiness"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"numberexists",children:"numberExists"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"numberExists"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"200"})," | ",(0,r.jsx)(n.code,{children:"404"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>o});var r=s(6540);const c={},t=r.createContext(c);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d1f64ba.16192ef7.js b/assets/js/0d1f64ba.16192ef7.js new file mode 100644 index 0000000000..8ab36006e0 --- /dev/null +++ b/assets/js/0d1f64ba.16192ef7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[599],{3325:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>c});var i=s(4848),l=s(8453);const o={},r="Interface: ConfigObject",t={id:"reference/api/model/config/interfaces/ConfigObject",title:"Interface: ConfigObject",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/ConfigObject.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/ConfigObject.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality"},next:{title:"Interface: DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"aggressiveGarbageCollection?",id:"aggressivegarbagecollection",level:3},{value:"authTimeout?",id:"authtimeout",level:3},{value:"Default",id:"default",level:4},{value:"autoEmoji?",id:"autoemoji",level:3},{value:"Default",id:"default-1",level:4},{value:"autoRefresh?",id:"autorefresh",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Default",id:"default-2",level:4},{value:"blockAssets?",id:"blockassets",level:3},{value:"Default",id:"default-3",level:4},{value:"blockCrashLogs?",id:"blockcrashlogs",level:3},{value:"Default",id:"default-4",level:4},{value:"browserRevision?",id:"browserrevision",level:3},{value:"browserWSEndpoint?",id:"browserwsendpoint",level:3},{value:"bypassCSP?",id:"bypasscsp",level:3},{value:"Default",id:"default-5",level:4},{value:"cacheEnabled?",id:"cacheenabled",level:3},{value:"Default",id:"default-6",level:4},{value:"cachedPatch?",id:"cachedpatch",level:3},{value:"Default",id:"default-7",level:4},{value:"callTimeout?",id:"calltimeout",level:3},{value:"Default",id:"default-8",level:4},{value:"chromiumArgs?",id:"chromiumargs",level:3},{value:"cloudUploadOptions?",id:"clouduploadoptions",level:3},{value:"accessKeyId",id:"accesskeyid",level:4},{value:"bucket",id:"bucket",level:4},{value:"directory?",id:"directory",level:4},{value:"headers?",id:"headers",level:4},{value:"Index Signature",id:"index-signature",level:5},{value:"ignoreHostAccount?",id:"ignorehostaccount",level:4},{value:"provider",id:"provider",level:4},{value:"public?",id:"public",level:4},{value:"region?",id:"region",level:4},{value:"secretAccessKey",id:"secretaccesskey",level:4},{value:"corsFix?",id:"corsfix",level:3},{value:"Default",id:"default-9",level:4},{value:"customUserAgent?",id:"customuseragent",level:3},{value:"deleteSessionDataOnLogout?",id:"deletesessiondataonlogout",level:3},{value:"Default",id:"default-10",level:4},{value:"devtools?",id:"devtools",level:3},{value:"disableSpins?",id:"disablespins",level:3},{value:"Default",id:"default-11",level:4},{value:"discord?",id:"discord",level:3},{value:"ensureHeadfulIntegrity?",id:"ensureheadfulintegrity",level:3},{value:"eventMode?",id:"eventmode",level:3},{value:"Default",id:"default-12",level:4},{value:"executablePath?",id:"executablepath",level:3},{value:"ezqr?",id:"ezqr",level:3},{value:"ghPatch?",id:"ghpatch",level:3},{value:"Default",id:"default-13",level:4},{value:"headless?",id:"headless",level:3},{value:"Default",id:"default-14",level:4},{value:"hostNotificationLang?",id:"hostnotificationlang",level:3},{value:"idCorrection?",id:"idcorrection",level:3},{value:"Default",id:"default-15",level:4},{value:"ignoreNuke?",id:"ignorenuke",level:3},{value:"inDocker?",id:"indocker",level:3},{value:"Default",id:"default-16",level:4},{value:"keepUpdated?",id:"keepupdated",level:3},{value:"Default",id:"default-17",level:4},{value:"killClientOnLogout?",id:"killclientonlogout",level:3},{value:"Default",id:"default-18",level:4},{value:"killProcessOnBan?",id:"killprocessonban",level:3},{value:"Default",id:"default-19",level:4},{value:"killProcessOnBrowserClose?",id:"killprocessonbrowserclose",level:3},{value:"Default",id:"default-20",level:4},{value:"killProcessOnTimeout?",id:"killprocessontimeout",level:3},{value:"Default",id:"default-21",level:4},{value:"legacy?",id:"legacy",level:3},{value:"Default",id:"default-22",level:4},{value:"licenseKey?",id:"licensekey",level:3},{value:"linkCode?",id:"linkcode",level:3},{value:"linkParser?",id:"linkparser",level:3},{value:"logConsole?",id:"logconsole",level:3},{value:"Default",id:"default-23",level:4},{value:"logConsoleErrors?",id:"logconsoleerrors",level:3},{value:"Default",id:"default-24",level:4},{value:"logDebugInfoAsObject?",id:"logdebuginfoasobject",level:3},{value:"Default",id:"default-25",level:4},{value:"logFile?",id:"logfile",level:3},{value:"Default",id:"default-26",level:4},{value:"logInternalEvents?",id:"loginternalevents",level:3},{value:"logging?",id:"logging",level:3},{value:"maxChats?",id:"maxchats",level:3},{value:"maxMessages?",id:"maxmessages",level:3},{value:"messagePreprocessor?",id:"messagepreprocessor",level:3},{value:"Default",id:"default-27",level:4},{value:"multiDevice?",id:"multidevice",level:3},{value:"Default",id:"default-28",level:4},{value:"onError?",id:"onerror",level:3},{value:"Default",id:"default-29",level:4},{value:"oorTimeout?",id:"oortimeout",level:3},{value:"Default",id:"default-30",level:4},{value:"pQueueDefault?",id:"pqueuedefault",level:3},{value:"Default",id:"default-31",level:4},{value:"popup?",id:"popup",level:3},{value:"Default",id:"default-32",level:4},{value:"preprocFilter?",id:"preprocfilter",level:3},{value:"Default",id:"default-33",level:4},{value:"proxyServerCredentials?",id:"proxyservercredentials",level:3},{value:"qrFormat?",id:"qrformat",level:3},{value:"Default",id:"default-34",level:4},{value:"qrLogSkip?",id:"qrlogskip",level:3},{value:"Default",id:"default-35",level:4},{value:"qrMax?",id:"qrmax",level:3},{value:"qrPopUpOnly?",id:"qrpopuponly",level:3},{value:"qrQuality?",id:"qrquality",level:3},{value:"Default",id:"default-36",level:4},{value:"qrRefreshS?",id:"qrrefreshs",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"qrTimeout?",id:"qrtimeout",level:3},{value:"Default",id:"default-37",level:4},{value:"raspi?",id:"raspi",level:3},{value:"Default",id:"default-38",level:4},{value:"resizable?",id:"resizable",level:3},{value:"Default",id:"default-39",level:4},{value:"restartOnCrash?",id:"restartoncrash",level:3},{value:"safeMode?",id:"safemode",level:3},{value:"Default",id:"default-40",level:4},{value:"screenshotOnInitializationBrowserError?",id:"screenshotoninitializationbrowsererror",level:3},{value:"Default",id:"default-41",level:4},{value:"sessionData?",id:"sessiondata",level:3},{value:"Deprecated",id:"deprecated-2",level:4},{value:"sessionDataBucketAuth?",id:"sessiondatabucketauth",level:3},{value:"sessionDataPath?",id:"sessiondatapath",level:3},{value:"sessionId?",id:"sessionid",level:3},{value:"Default",id:"default-42",level:4},{value:"skipBrokenMethodsCheck?",id:"skipbrokenmethodscheck",level:3},{value:"Default",id:"default-43",level:4},{value:"skipSessionSave?",id:"skipsessionsave",level:3},{value:"Default",id:"default-44",level:4},{value:"skipUpdateCheck?",id:"skipupdatecheck",level:3},{value:"Default",id:"default-45",level:4},{value:"stickerServerEndpoint?",id:"stickerserverendpoint",level:3},{value:"Default",id:"default-46",level:4},{value:"throwErrorOnTosBlock?",id:"throwerrorontosblock",level:3},{value:"throwOnExpiredSessionData?",id:"throwonexpiredsessiondata",level:3},{value:"Default",id:"default-47",level:4},{value:"useChrome?",id:"usechrome",level:3},{value:"Default",id:"default-48",level:4},{value:"useNativeProxy?",id:"usenativeproxy",level:3},{value:"Default",id:"default-49",level:4},{value:"useStealth?",id:"usestealth",level:3},{value:"Default",id:"default-50",level:4},{value:"viewport?",id:"viewport",level:3},{value:"height?",id:"height",level:4},{value:"Default",id:"default-51",level:5},{value:"width?",id:"width",level:4},{value:"Default",id:"default-52",level:5},{value:"waitForRipeSession?",id:"waitforripesession",level:3},{value:"waitForRipeSessionTimeout?",id:"waitforripesessiontimeout",level:3},{value:"Default",id:"default-53",level:4}];function h(e){const n={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-configobject",children:"Interface: ConfigObject"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aggressivegarbagecollection",children:"aggressiveGarbageCollection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"aggressiveGarbageCollection"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to true will run ",(0,i.jsx)(n.code,{children:"gc()"})," on before every command sent to the browser."]}),"\n",(0,i.jsx)(n.p,{children:"This is experimental and may not work or it may have unforeseen sideeffects."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"authtimeout",children:"authTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"authTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This determines how long the process should wait for the session authentication. If exceeded, checks if phone is out of reach (turned of or without internet connection) and throws an error. It does not relate to the amount of time spent waiting for a qr code scan (see [[qrTimeout]]). To have the system wait continuously, set this to ",(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"60"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"autoemoji",children:"autoEmoji?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"autoEmoji"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set the automatic emoji detection character. Set this to ",(0,i.jsx)(n.code,{children:"false"})," to disable auto emoji. Default is ",(0,i.jsx)(n.code,{children:":"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:":"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"autorefresh",children:(0,i.jsx)(n.del,{children:"autoRefresh?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"autoRefresh"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["THIS IS LOCKED TO ",(0,i.jsx)(n.code,{children:"true"})," AND CANNOT BE TURNED OFF. PLEASE SEE [[authTimeout]]"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will result in new QR codes being generated if the end user takes too long to scan the QR code."}),"\n",(0,i.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blockassets",children:"blockAssets?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"blockAssets"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will block all assets from loading onto the page. This may result in some load time improvements but also increases instability."}),"\n",(0,i.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blockcrashlogs",children:"blockCrashLogs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"blockCrashLogs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will block any network calls to crash log servers. This should keep anything you do under the radar."}),"\n",(0,i.jsx)(n.h4,{id:"default-4",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"browserrevision",children:"browserRevision?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"browserRevision"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This is the specific browser revision to be downlaoded and used. You can find browser revision strings here: ",(0,i.jsx)(n.a,{href:"http://omahaproxy.appspot.com/",children:"http://omahaproxy.appspot.com/"}),"\nLearn more about it here: ",(0,i.jsx)(n.a,{href:"https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browserfetcher",children:"https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browserfetcher"}),"\nIf you're having trouble with sending images, try '737027'.\nIf you go too far back things will start breaking !!!!!!\nNOTE: THIS WILL OVERRIDE useChrome and executablePath. ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"browserwsendpoint",children:"browserWSEndpoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"browserWSEndpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING."}),"\n",(0,i.jsx)(n.p,{children:"Learn more:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions",children:"https://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions"})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0",children:"https://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"bypasscsp",children:"bypassCSP?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"bypassCSP"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Disable cors see: ",(0,i.jsx)(n.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v3.0.4&show=api-pagesetbypasscspenabled",children:"https://pptr.dev/#?product=Puppeteer&version=v3.0.4&show=api-pagesetbypasscspenabled"})," If you are having an issue with sending media try to set this to true. Otherwise leave it set to false."]}),"\n",(0,i.jsx)(n.h4,{id:"default-5",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cacheenabled",children:"cacheEnabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cacheEnabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to false turn off the cache. This may improve memory usage."}),"\n",(0,i.jsx)(n.h4,{id:"default-6",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachedpatch",children:"cachedPatch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cachedPatch"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to ",(0,i.jsx)(n.code,{children:"true"})," will save a local copy of the patches.json file (as patches.ignore.data.json) which will be used in subsequent instantiations of the session. While the rest of the launch procedure is running, the library will fetch and save a recent version of the patches to ensure your patches don't go stale. This will be ignored if the cached patches are more than a day old."]}),"\n",(0,i.jsx)(n.h4,{id:"default-7",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"calltimeout",children:"callTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"callTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Amount of time (in ms) to wait for a client method (specifically methods that interact with the WA web session) to resolve. If a client method results takes longer than the timout value then it will result in a [[PageEvaluationTimeout]] error."}),"\n",(0,i.jsx)(n.p,{children:"If you get this error, it does not automatically mean that the method failed - it just stops your program from waiting for a client method to resolve."}),"\n",(0,i.jsx)(n.p,{children:"This is useful if you do not rely on the results of a client method (e.g the message ID)."}),"\n",(0,i.jsxs)(n.p,{children:["If set to ",(0,i.jsx)(n.code,{children:"0"}),", the process will wait indefinitely for a client method to resolve."]}),"\n",(0,i.jsx)(n.h4,{id:"default-8",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"0\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"chromiumargs",children:"chromiumArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"chromiumArgs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This allows you to pass any array of custom chrome/chromium argument strings to the puppeteer instance.\nYou can find all possible arguements ",(0,i.jsx)(n.a,{href:"https://peter.sh/experiments/chromium-command-line-switches/",children:"here"}),"."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"clouduploadoptions",children:"cloudUploadOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cloudUploadOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["REQUIRED IF ",(0,i.jsx)(n.code,{children:"messagePreprocessor"})," IS SET TO ",(0,i.jsx)(n.code,{children:"UPLOAD_CLOUD"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"This can be set via the config or the corresponding environment variables."}),"\n",(0,i.jsx)(n.h4,{id:"accesskeyid",children:"accessKeyId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"accessKeyId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"S3 compatible access key ID."}),"\n",(0,i.jsxs)(n.p,{children:["e.g: ",(0,i.jsx)(n.code,{children:"AKIAIOSFODNN7EXAMPLE"})," or ",(0,i.jsx)(n.code,{children:"GOOGTS7C7FUP3AIRVJTE2BCD"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_ACCESS_KEY_ID"})]}),"\n",(0,i.jsx)(n.h4,{id:"bucket",children:"bucket"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"bucket"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Bucket name"}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_BUCKET"})]}),"\n",(0,i.jsx)(n.h4,{id:"directory",children:"directory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"directory"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The directory strategy to use when uploading files. Or just set it to a custom directory string."}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_DIRECTORY"})]}),"\n",(0,i.jsx)(n.h4,{id:"headers",children:"headers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"headers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra headers to add to the upload request"}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"k"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"ignorehostaccount",children:"ignoreHostAccount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreHostAccount"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Ignore processing of messages that are sent by the host account itself"}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_IGNORE_HOST"})]}),"\n",(0,i.jsx)(n.h4,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:(0,i.jsx)(n.code,{children:"CLOUD_PROVIDERS"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AWS"}),", ",(0,i.jsx)(n.code,{children:"GCP"})," or ",(0,i.jsx)(n.code,{children:"WASABI"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_ACCESS_KEY_ID"})]}),"\n",(0,i.jsx)(n.h4,{id:"public",children:"public?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"public"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will make the uploaded file public"}),"\n",(0,i.jsx)(n.h4,{id:"region",children:"region?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"region"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Bucket region."}),"\n",(0,i.jsxs)(n.p,{children:["Not required for ",(0,i.jsx)(n.code,{children:"GCP"})," provider"]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_REGION"})]}),"\n",(0,i.jsx)(n.h4,{id:"secretaccesskey",children:"secretAccessKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"secretAccessKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"S3 compatible secret access key."}),"\n",(0,i.jsxs)(n.p,{children:["e.g ",(0,i.jsx)(n.code,{children:"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_SECRET_ACCESS_KEY"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"corsfix",children:"corsFix?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"corsFix"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will bypass web security. DO NOT DO THIS IF YOU DO NOT HAVE TO. CORS issue may arise when using a proxy."}),"\n",(0,i.jsx)(n.h4,{id:"default-9",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"customuseragent",children:"customUserAgent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"customUserAgent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You may set a custom user agent. However, due to recent developments, this is not really neccessary any more."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deletesessiondataonlogout",children:"deleteSessionDataOnLogout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"deleteSessionDataOnLogout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Deletes the session data file (if found) on logout event. This results in a quicker login when you restart the process."}),"\n",(0,i.jsx)(n.h4,{id:"default-10",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devtools",children:"devtools?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"devtools"}),": ",(0,i.jsx)(n.code,{children:"boolean"})," | ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:(0,i.jsx)(n.code,{children:"DevTools"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You can enable remote devtools by setting this to trye. If you set this to true there will be security on the devtools url.\nIf you want, you can also pass a username & password."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"disablespins",children:"disableSpins?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"disableSpins"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will simplify logs for use within docker containers by disabling spins (will still print raw messages)."}),"\n",(0,i.jsx)(n.h4,{id:"default-11",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"discord",children:"discord?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"discord"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Your Discord ID to get onto the sticker leaderboard!"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ensureheadfulintegrity",children:"ensureHeadfulIntegrity?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ensureHeadfulIntegrity"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Makes sure the headless session is usable even on first login.\nHeadful sessions are ususally only usable on reauthentication."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventmode",children:"eventMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"eventMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting listeners may not be your cup of tea. With eventMode, all [[SimpleListener]] events will be registered automatically and be filed via the built in Events Listener."}),"\n",(0,i.jsx)(n.p,{children:"This is useful because you can register/deregister the event listener as needed whereas the legacy method of setting callbacks are only be set once"}),"\n",(0,i.jsx)(n.h4,{id:"default-12",children:"Default"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"}),";"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"executablepath",children:"executablePath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"executablePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Some features, like video upload, do not work without a chrome instance. Set this to the path of your chrome instance or you can use ",(0,i.jsx)(n.code,{children:"useChrome:true"})," to automatically detect a chrome instance for you. Please note, this overrides ",(0,i.jsx)(n.code,{children:"useChrome"}),"."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ezqr",children:"ezqr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ezqr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Expose a URL where you can easily scan the qr code"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ghpatch",children:"ghPatch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ghPatch"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This will force the library to use the default cached raw github link for patches to shave a few hundred milliseconds from your launch time. If you use this option, you will need to wait about 5 minutes before trying out new patches."}),"\n",(0,i.jsx)(n.h4,{id:"default-13",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"headless",children:"headless?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"headless"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"By default, all instances of @open-wa/wa-automate are headless (i.e you don't see a chrome window open), you can set this to false to show the chrome/chromium window."}),"\n",(0,i.jsx)(n.h4,{id:"default-14",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnotificationlang",children:"hostNotificationLang?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"hostNotificationLang"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:(0,i.jsx)(n.code,{children:"NotificationLanguage"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The language of the host notification. See: ",(0,i.jsx)(n.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088",children:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"idcorrection",children:"idCorrection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"idCorrection"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["When true, the system will attempt to correct chatIds and groupChatIds. This means you can ignore ",(0,i.jsx)(n.code,{children:"@c.us"})," and ",(0,i.jsx)(n.code,{children:"@g.us"})," distinctions in some parameters."]}),"\n",(0,i.jsx)(n.h4,{id:"default-15",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ignorenuke",children:"ignoreNuke?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreNuke"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Don't implicitly determine if the host logged out."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"indocker",children:"inDocker?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"inDocker"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will try infer as many config variables as possible from the environment variables. The format of the variables are as below:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"sessionData ==> WA_SESSION_DATA\nsessionDataPath ==> WA_SESSION_DATA_PATH\nsessionId ==> WA_SESSION_ID\ncustomUserAgent ==> WA_CUSTOM_USER_AGENT\nblockCrashLogs ==> WA_BLOCK_CRASH_LOGS\nblockAssets ==> WA_BLOCK_ASSETS\ncorsFix ==> WA_CORS_FIX\ncacheEnabled ==> WA_CACHE_ENABLED\nheadless ==> WA_HEADLESS\nqrTimeout ==> WA_QR_TIMEOUT\nuseChrome ==> WA_USE_CHROME\nqrLogSkip ==> WA_QR_LOG_SKIP\ndisableSpins ==> WA_DISABLE_SPINS\nlogConsole ==> WA_LOG_CONSOLE\nlogConsoleErrors==> WA_LOG_CONSOLE_ERRORS\nauthTimeout ==> WA_AUTH_TIMEOUT\nsafeMode ==> WA_SAFE_MODE\nskipSessionSave ==> WA_SKIP_SESSION_SAVE\npopup ==> WA_POPUP \nlicensekey ==> WA_LICENSE_KEY \n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-16",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"keepupdated",children:"keepUpdated?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"keepUpdated"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["[ALPHA FEATURE - ONLY IMPLEMENTED FOR TESTING - DO NOT USE IN PRODUCTION YET]\nSetting this to true will result in the library making sure it is always starting with the latest version of itself. This overrides ",(0,i.jsx)(n.code,{children:"skipUpdateCheck"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-17",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killclientonlogout",children:"killClientOnLogout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killClientOnLogout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Kill the client when a logout is detected"}),"\n",(0,i.jsx)(n.h4,{id:"default-18",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessonban",children:"killProcessOnBan?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnBan"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:['If set to true, the system will kill the whole node process when a "TEMPORARY BAN" is detected. This is useful to prevent hanging processes.\nIt is ',(0,i.jsx)(n.code,{children:"true"})," by default because it is a very rare event and it is better to kill the process than to leave it hanging."]}),"\n",(0,i.jsx)(n.h4,{id:"default-19",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessonbrowserclose",children:"killProcessOnBrowserClose?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnBrowserClose"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to ",(0,i.jsx)(n.code,{children:"true"})," will kill the whole process when the client is disconnected from the page or if the browser is closed."]}),"\n",(0,i.jsx)(n.h4,{id:"default-20",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessontimeout",children:"killProcessOnTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnTimeout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set to true, the system will kill the whole node process when either an [[authTimeout]] or a [[qrTimeout]] has been reached. This is useful to prevent hanging processes."}),"\n",(0,i.jsx)(n.h4,{id:"default-21",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"legacy",children:"legacy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"legacy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"As the library is constantly evolving, some parts will be replaced with more efficient and improved code. In some of the infinite edge cases these new changes may not work for you. Set this to true to roll back on 'late beta' features. The reason why legacy is false by default is that in order for features to be tested they have to be released and used by everyone to find the edge cases and fix them."}),"\n",(0,i.jsx)(n.h4,{id:"default-22",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"licensekey",children:"licenseKey?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"licenseKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In order to unlock the functionality to send texts to unknown numbers, you need a License key.\nOne License Key is valid for each number. Each License Key starts from \xa35 per month."}),"\n",(0,i.jsx)(n.p,{children:"Please check README for instructions on how to get a license key."}),"\n",(0,i.jsx)(n.p,{children:"Notes:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"You can change the number assigned to that License Key at any time, just message me the new number on the private discord channel."}),"\n",(0,i.jsx)(n.li,{children:"In order to cancel your License Key, simply stop your membership."}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linkcode",children:"linkCode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"linkCode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"There is a new way to login to your host account by entering a link code after a confirmation step from the host account device. In order to use this feature you MUST set the host account number as a string or number beforehand as a property of the config object."}),"\n",(0,i.jsx)(n.p,{children:"e.g"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"linkCode: '1234567890'\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linkparser",children:"linkParser?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"linkParser"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The URL of your instance of ",(0,i.jsx)(n.a,{href:"https://github.com/RemiixInc/meta-grabber-serverless",children:"serverless meta grabber"})," by ",(0,i.jsx)(n.a,{href:"https://github.com/RemiixInc",children:"RemiixInc"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["default: ",(0,i.jsx)(n.code,{children:"https://link.openwa.cloud/api"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconsole",children:"logConsole?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logConsole"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, this will log any console messages from the browser."}),"\n",(0,i.jsx)(n.h4,{id:"default-23",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconsoleerrors",children:"logConsoleErrors?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logConsoleErrors"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, this will log any error messages from the browser instance"}),"\n",(0,i.jsx)(n.h4,{id:"default-24",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logdebuginfoasobject",children:"logDebugInfoAsObject?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logDebugInfoAsObject"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting ",(0,i.jsx)(n.code,{children:"this"})," to true will replace the ",(0,i.jsx)(n.code,{children:"console.table"})," with a stringified logging of the debug info object instead. This would be useful to set for smaller terminal windows. If ",(0,i.jsx)(n.code,{children:"disableSpins"})," is ",(0,i.jsx)(n.code,{children:"true"})," then this will also be ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-25",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logfile",children:"logFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logFile"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the system will automatically create a log of all processes relating to actions sent to the web session."}),"\n",(0,i.jsx)(n.p,{children:"The location of the file will be relative to the process directory (pd)"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"[pd]/[sessionId]/[start timestamp].log"})}),"\n",(0,i.jsx)(n.h4,{id:"default-26",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"loginternalevents",children:"logInternalEvents?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logInternalEvents"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This will make the library log all internal wa web events to the console. This is useful for debugging purposes. DO NOT TURN THIS ON UNLESS ASKED TO."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logging",children:"logging?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logging"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",children:(0,i.jsx)(n.code,{children:"ConfigLogTransport"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An array of ",(0,i.jsx)(n.a,{href:"https://github.com/winstonjs/winston/blob/master/docs/transports.md#additional-transports",children:"winston"})," logging transport configurations."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/open-wa/wa-automate-nodejs/discussions/2373",children:"Check this discussion to see how to set up logging"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxchats",children:"maxChats?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxChats"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the maximum amount of chats to be present in a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxmessages",children:"maxMessages?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxMessages"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the maximum amount of messages to be present in a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"messagepreprocessor",children:"messagePreprocessor?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"messagePreprocessor"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set a preprocessor, or multiple chained preprocessors, for messages. See ",(0,i.jsx)(n.a,{href:"/",children:"MPConfigType"})," for more info."]}),"\n",(0,i.jsxs)(n.p,{children:["options: ",(0,i.jsx)(n.code,{children:"SCRUB"}),", ",(0,i.jsx)(n.code,{children:"BODY_ONLY"}),", ",(0,i.jsx)(n.code,{children:"AUTO_DECRYPT"}),", ",(0,i.jsx)(n.code,{children:"AUTO_DECRYPT_SAVE"}),", ",(0,i.jsx)(n.code,{children:"UPLOAD_CLOUD"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-27",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multidevice",children:"multiDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"multiDevice"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Please note that multi-device is still in beta so a lot of things may not work. It is HIGHLY suggested to NOT use this in production!!!!"}),"\n",(0,i.jsx)(n.p,{children:"Set this to true if you're using the multidevice beta."}),"\n",(0,i.jsx)(n.h4,{id:"default-28",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.admonition,{type:"danger",children:(0,i.jsxs)(n.p,{children:["Some features (e.g [[sendLinkWithAutoPreview]]) ",(0,i.jsx)(n.strong,{children:"do not"})," work with multi-device beta. Check ",(0,i.jsxs)(n.a,{href:"#",children:["this ",(0,i.jsx)(n.code,{children:"api"})]}),"."]})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onerror",children:"onError?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"onError"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:(0,i.jsx)(n.code,{children:"OnError"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What to do when an error is detected on a client method."}),"\n",(0,i.jsx)(n.h4,{id:"default-29",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"OnError.NOTHING"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oortimeout",children:"oorTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"oorTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"phoneIsOutOfReach check timeout"}),"\n",(0,i.jsx)(n.h4,{id:"default-30",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"60"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pqueuedefault",children:"pQueueDefault?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pQueueDefault"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default pqueue options applied to all listeners that can take pqueue options as a second optional parameter. For now, this only includes ",(0,i.jsx)(n.code,{children:"onMessage"})," and ",(0,i.jsx)(n.code,{children:"onAnyMessage"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["See: ",(0,i.jsx)(n.a,{href:"https://github.com/sindresorhus/p-queue#options",children:"https://github.com/sindresorhus/p-queue#options"})]}),"\n",(0,i.jsx)(n.p,{children:"Example: process 5 events within every 3 seconds window. Make sure to only process at most 2 at any one time. Make sure there is at least 100ms between each event processing."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:" { \n intervalCap: 5, //process 5 events\n interval: 3000, //within every three second window\n concurrency: 2, //make sure to process, at most, 2 events at any one time\n timeout: 100, //make sure there is a 100ms gap between each event processing.\n carryoverConcurrencyCount: true //If there are more than 5 events in that period, process them within the next 3 second period. Make sure this is always set to true!!!\n }\n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-31",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"popup",children:"popup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"popup"}),": ",(0,i.jsx)(n.code,{children:"number"})," | ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will open a browser window where you will see basic event logs and QR codes to authenticate the session. Usually it will open on port 3000. It can also be set to a preferred port."}),"\n",(0,i.jsx)(n.p,{children:"You can also get the QR code png at (if localhost and port 3000):"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"http://localhost:3000/qr"})}),"\n",(0,i.jsx)(n.p,{children:"or if you have multiple session:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"http://localhost:3000/qr?sessionId=[sessionId]"})}),"\n",(0,i.jsx)(n.h4,{id:"default-32",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false | 3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"preprocfilter",children:"preprocFilter?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"preprocFilter"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set an array filter to be used with messagePreprocessor to limit which messages are preprocessed."}),"\n",(0,i.jsxs)(n.p,{children:["E.g if you want to scrub all messages that are not from a group, you can do the following:\n",(0,i.jsx)(n.code,{children:'"m=>!m.isGroupMsg"'})]}),"\n",(0,i.jsx)(n.h4,{id:"default-33",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"proxyservercredentials",children:"proxyServerCredentials?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"proxyServerCredentials"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:(0,i.jsx)(n.code,{children:"ProxyServerCredentials"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If sent, adds a call to waPage.authenticate with those credentials. Set ",(0,i.jsx)(n.code,{children:"corsFix"})," to true if using a proxy results in CORS errors."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrformat",children:"qrFormat?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrFormat"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:(0,i.jsx)(n.code,{children:"QRFormat"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The output format of the qr code. ",(0,i.jsx)(n.code,{children:"png"}),", ",(0,i.jsx)(n.code,{children:"jpeg"})," or ",(0,i.jsx)(n.code,{children:"webm"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-34",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"png"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrlogskip",children:"qrLogSkip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrLogSkip"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, skips logging the QR Code to the console."}),"\n",(0,i.jsx)(n.h4,{id:"default-35",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrmax",children:"qrMax?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrMax"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Automatically kill the process after a set amount of qr codes"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrpopuponly",children:"qrPopUpOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrPopUpOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This needs to be used in conjuction with ",(0,i.jsx)(n.code,{children:"popup"}),", if ",(0,i.jsx)(n.code,{children:"popup"})," is not true or a number (representing a desired port) then this will not work."]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will make sure that only the qr code png is served via the web server. This is useful if you do not need the whole status page."}),"\n",(0,i.jsxs)(n.p,{children:["As mentioned in ",(0,i.jsx)(n.a,{href:"#popup",children:"popup"}),", the url for the qr code is ",(0,i.jsx)(n.code,{children:"http://localhost:3000/qr"})," if the port is 3000."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrquality",children:"qrQuality?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrQuality"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:(0,i.jsx)(n.code,{children:"QRQuality"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The output quality of the qr code during authentication. This can be any increment of 0.1 from 0.1 to 1.0."}),"\n",(0,i.jsx)(n.h4,{id:"default-36",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"1.0"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrrefreshs",children:(0,i.jsx)(n.del,{children:"qrRefreshS?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrRefreshS"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsx)(n.p,{children:"This now has no effect"}),"\n",(0,i.jsx)(n.p,{children:"This determines the interval at which to refresh the QR code. By default, WA updates the qr code every 18-19 seconds so make sure this value is set to UNDER 18 seconds!!"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrtimeout",children:"qrTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This determines how long the process should wait for a QR code to be scanned before killing the process entirely. To have the system wait continuously, set this to ",(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-37",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"60\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"raspi",children:"raspi?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"raspi"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set this to ",(0,i.jsx)(n.code,{children:"true"})," to make the library work on Raspberry Pi OS."]}),"\n",(0,i.jsx)(n.p,{children:"Make sure to run the following command before running the library the first time:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"> sudo apt update -y && sudo apt install chromium-browser chromium-codecs-ffmpeg -y && sudo apt upgrade\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you're using the CLI, you can set this value to ",(0,i.jsx)(n.code,{children:"true"})," by adding the following flag to the CLI command"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"> npx @open-wa/wa-automate ... --raspi\n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-38",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resizable",children:"resizable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"resizable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Syncs the viewport size with the window size which is how normal browsers act. Only relevant when ",(0,i.jsx)(n.code,{children:"headless: false"})," and this overrides ",(0,i.jsx)(n.code,{children:"viewport"})," config."]}),"\n",(0,i.jsx)(n.h4,{id:"default-39",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartoncrash",children:"restartOnCrash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"restartOnCrash"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set, the program will try to recreate itself when the page crashes. You have to pass the function that you want called upon restart. Please note that when the page crashes you may miss some messages.\nE.g:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:"const start = async (client: Client) => {...}\ncreate({\n...\nrestartOnCrash: start,\n...\n})\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"safemode",children:"safeMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"safeMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, client will check if the page is valid before each command. If page is not valid, it will throw an error."}),"\n",(0,i.jsx)(n.h4,{id:"default-40",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"screenshotoninitializationbrowsererror",children:"screenshotOnInitializationBrowserError?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"screenshotOnInitializationBrowserError"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["When true, this option will take a screenshot of the browser when an unexpected error occurs within the browser during ",(0,i.jsx)(n.code,{children:"create"})," initialization. The path will be ",(0,i.jsx)(n.code,{children:"[working directory]/logs/[session ID]/[start timestamp]/[timestamp].jpg"})]}),"\n",(0,i.jsx)(n.h4,{id:"default-41",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondata",children:(0,i.jsx)(n.del,{children:"sessionData?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionData"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,i.jsx)(n.code,{children:"Base64"})})," | ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:(0,i.jsx)(n.code,{children:"SessionData"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,i.jsx)(n.p,{children:"The authentication object (as a JSON object or a base64 encoded string) that is required to migrate a session from one instance to another or to just restart an existing instance.\nThis sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event."}),"\n",(0,i.jsx)(n.p,{children:"You can capture the event like so:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:"import {create, ev} from '@open-wa/wa-automate';\n\n ev.on('sessionData.**', async (sessionData, sessionId) =>{\n console.log(sessionId, sessionData)\n })\n\n//or as base64 encoded string\n\n ev.on('sessionDataBase64.**', async (sessionDatastring, sessionId) =>{\n console.log(sessionId, sessionDatastring)\n })\n"})}),"\n",(0,i.jsx)(n.p,{children:"NOTE: You can set sessionData as an evironmental variable also! The variable name has to be [sessionId (default = 'session) in all caps]_DATA_JSON. You have to make sure to surround your session data with single quotes to maintain the formatting."}),"\n",(0,i.jsx)(n.p,{children:"For example:"}),"\n",(0,i.jsx)(n.p,{children:"sessionId = 'session'"}),"\n",(0,i.jsx)(n.p,{children:"To set env var:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:" export SESSION_DATA_JSON=`...`\n"})}),"\n",(0,i.jsxs)(n.p,{children:["where ... is copied from session.data.json this will be a string most likley starting in ",(0,i.jsx)(n.code,{children:"ey..."})," and ending with ",(0,i.jsx)(n.code,{children:"=="})]}),"\n",(0,i.jsx)(n.p,{children:"Setting the sessionData in the environmental variable will override the sessionData object in the config."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondatabucketauth",children:"sessionDataBucketAuth?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionDataBucketAuth"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondatapath",children:"sessionDataPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionDataPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The path relative to the current working directory (i.e where you run the command to start your process). This will be used to store and read your ",(0,i.jsx)(n.code,{children:".data.json"})," files. defualt to ''"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessionid",children:"sessionId?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This is the name of the session. You have to make sure that this is unique for every session."}),"\n",(0,i.jsx)(n.h4,{id:"default-42",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"session"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipbrokenmethodscheck",children:"skipBrokenMethodsCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipBrokenMethodsCheck"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set to true, skipBrokenMethodsCheck will bypass the health check before startup. It is highly suggested to not set this to true."}),"\n",(0,i.jsx)(n.h4,{id:"default-43",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipsessionsave",children:"skipSessionSave?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipSessionSave"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will not save a data.json file. This means that sessions will not be saved and you will need to pass sessionData as a config param or create the session data.json file yourself"}),"\n",(0,i.jsx)(n.h4,{id:"default-44",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipupdatecheck",children:"skipUpdateCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipUpdateCheck"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If set to true, ",(0,i.jsx)(n.code,{children:"skipUpdateCheck"})," will bypass the latest version check. This saves some time on boot (around 150 ms)."]}),"\n",(0,i.jsx)(n.h4,{id:"default-45",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stickerserverendpoint",children:"stickerServerEndpoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"stickerServerEndpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Redundant until self-hostable sticker server is available."}),"\n",(0,i.jsx)(n.h4,{id:"default-46",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"https://sticker-api.openwa.dev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throwerrorontosblock",children:"throwErrorOnTosBlock?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"throwErrorOnTosBlock"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will throw an error if a session is not able to get a QR code or is unable to restart a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throwonexpiredsessiondata",children:"throwOnExpiredSessionData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"throwOnExpiredSessionData"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This will make the ",(0,i.jsx)(n.code,{children:"create"})," command return ",(0,i.jsx)(n.code,{children:"false"})," if the detected session data is expired."]}),"\n",(0,i.jsx)(n.p,{children:"This will mean, the process will not attempt to automatically get a new QR code."}),"\n",(0,i.jsx)(n.h4,{id:"default-47",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usechrome",children:"useChrome?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useChrome"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath."}),"\n",(0,i.jsx)(n.h4,{id:"default-48",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usenativeproxy",children:"useNativeProxy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useNativeProxy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Some sessions may experience issues with sending media when using proxies. Using the native proxy system instead of the recommended 3rd party library may fix these issues."}),"\n",(0,i.jsx)(n.h4,{id:"default-49",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usestealth",children:"useStealth?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useStealth"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This flag allows you to disable or enable the use of the puppeteer stealth plugin. It is a good idea to use it, however it can cause issues sometimes. Set this to false if you are experiencing ",(0,i.jsx)(n.code,{children:"browser.setMaxListeneres"})," issue. For now the default for this is false."]}),"\n",(0,i.jsx)(n.h4,{id:"default-50",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewport",children:"viewport?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"viewport"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g ",(0,i.jsx)(n.code,{children:"--viewport 1920x1080"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"height",children:"height?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"height"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Page height in pixels"}),"\n",(0,i.jsx)(n.h5,{id:"default-51",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"900"})}),"\n",(0,i.jsx)(n.h4,{id:"width",children:"width?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"width"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Page width in pixels"}),"\n",(0,i.jsx)(n.h5,{id:"default-52",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"1440"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"waitforripesession",children:"waitForRipeSession?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"waitForRipeSession"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["wait for a valid headful session. Not required in recent versions.\ndefault: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"waitforripesessiontimeout",children:"waitForRipeSessionTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"waitForRipeSessionTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This determines how long the process should wait for a session to load fully before continuing the launch process.\nSet this to 0 to wait forever. Default is 5 seconds."}),"\n",(0,i.jsx)(n.h4,{id:"default-53",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"5\n"})})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>t});var i=s(6540);const l={},o=i.createContext(l);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d1f64ba.4aaaae2e.js b/assets/js/0d1f64ba.4aaaae2e.js deleted file mode 100644 index 2089c015c0..0000000000 --- a/assets/js/0d1f64ba.4aaaae2e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[599],{3325:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>c});var i=s(4848),l=s(8453);const o={},r="Interface: ConfigObject",t={id:"reference/api/model/config/interfaces/ConfigObject",title:"Interface: ConfigObject",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/ConfigObject.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/ConfigObject.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality"},next:{title:"Interface: DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"aggressiveGarbageCollection?",id:"aggressivegarbagecollection",level:3},{value:"authTimeout?",id:"authtimeout",level:3},{value:"Default",id:"default",level:4},{value:"autoEmoji?",id:"autoemoji",level:3},{value:"Default",id:"default-1",level:4},{value:"autoRefresh?",id:"autorefresh",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Default",id:"default-2",level:4},{value:"blockAssets?",id:"blockassets",level:3},{value:"Default",id:"default-3",level:4},{value:"blockCrashLogs?",id:"blockcrashlogs",level:3},{value:"Default",id:"default-4",level:4},{value:"browserRevision?",id:"browserrevision",level:3},{value:"browserWSEndpoint?",id:"browserwsendpoint",level:3},{value:"bypassCSP?",id:"bypasscsp",level:3},{value:"Default",id:"default-5",level:4},{value:"cacheEnabled?",id:"cacheenabled",level:3},{value:"Default",id:"default-6",level:4},{value:"cachedPatch?",id:"cachedpatch",level:3},{value:"Default",id:"default-7",level:4},{value:"callTimeout?",id:"calltimeout",level:3},{value:"Default",id:"default-8",level:4},{value:"chromiumArgs?",id:"chromiumargs",level:3},{value:"cloudUploadOptions?",id:"clouduploadoptions",level:3},{value:"accessKeyId",id:"accesskeyid",level:4},{value:"bucket",id:"bucket",level:4},{value:"directory?",id:"directory",level:4},{value:"headers?",id:"headers",level:4},{value:"Index Signature",id:"index-signature",level:5},{value:"ignoreHostAccount?",id:"ignorehostaccount",level:4},{value:"provider",id:"provider",level:4},{value:"public?",id:"public",level:4},{value:"region?",id:"region",level:4},{value:"secretAccessKey",id:"secretaccesskey",level:4},{value:"corsFix?",id:"corsfix",level:3},{value:"Default",id:"default-9",level:4},{value:"customUserAgent?",id:"customuseragent",level:3},{value:"deleteSessionDataOnLogout?",id:"deletesessiondataonlogout",level:3},{value:"Default",id:"default-10",level:4},{value:"devtools?",id:"devtools",level:3},{value:"disableSpins?",id:"disablespins",level:3},{value:"Default",id:"default-11",level:4},{value:"discord?",id:"discord",level:3},{value:"ensureHeadfulIntegrity?",id:"ensureheadfulintegrity",level:3},{value:"eventMode?",id:"eventmode",level:3},{value:"Default",id:"default-12",level:4},{value:"executablePath?",id:"executablepath",level:3},{value:"ezqr?",id:"ezqr",level:3},{value:"ghPatch?",id:"ghpatch",level:3},{value:"Default",id:"default-13",level:4},{value:"headless?",id:"headless",level:3},{value:"Default",id:"default-14",level:4},{value:"hostNotificationLang?",id:"hostnotificationlang",level:3},{value:"idCorrection?",id:"idcorrection",level:3},{value:"Default",id:"default-15",level:4},{value:"ignoreNuke?",id:"ignorenuke",level:3},{value:"inDocker?",id:"indocker",level:3},{value:"Default",id:"default-16",level:4},{value:"keepUpdated?",id:"keepupdated",level:3},{value:"Default",id:"default-17",level:4},{value:"killClientOnLogout?",id:"killclientonlogout",level:3},{value:"Default",id:"default-18",level:4},{value:"killProcessOnBan?",id:"killprocessonban",level:3},{value:"Default",id:"default-19",level:4},{value:"killProcessOnBrowserClose?",id:"killprocessonbrowserclose",level:3},{value:"Default",id:"default-20",level:4},{value:"killProcessOnTimeout?",id:"killprocessontimeout",level:3},{value:"Default",id:"default-21",level:4},{value:"legacy?",id:"legacy",level:3},{value:"Default",id:"default-22",level:4},{value:"licenseKey?",id:"licensekey",level:3},{value:"linkCode?",id:"linkcode",level:3},{value:"linkParser?",id:"linkparser",level:3},{value:"logConsole?",id:"logconsole",level:3},{value:"Default",id:"default-23",level:4},{value:"logConsoleErrors?",id:"logconsoleerrors",level:3},{value:"Default",id:"default-24",level:4},{value:"logDebugInfoAsObject?",id:"logdebuginfoasobject",level:3},{value:"Default",id:"default-25",level:4},{value:"logFile?",id:"logfile",level:3},{value:"Default",id:"default-26",level:4},{value:"logInternalEvents?",id:"loginternalevents",level:3},{value:"logging?",id:"logging",level:3},{value:"maxChats?",id:"maxchats",level:3},{value:"maxMessages?",id:"maxmessages",level:3},{value:"messagePreprocessor?",id:"messagepreprocessor",level:3},{value:"Default",id:"default-27",level:4},{value:"multiDevice?",id:"multidevice",level:3},{value:"Default",id:"default-28",level:4},{value:"onError?",id:"onerror",level:3},{value:"Default",id:"default-29",level:4},{value:"oorTimeout?",id:"oortimeout",level:3},{value:"Default",id:"default-30",level:4},{value:"pQueueDefault?",id:"pqueuedefault",level:3},{value:"Default",id:"default-31",level:4},{value:"popup?",id:"popup",level:3},{value:"Default",id:"default-32",level:4},{value:"preprocFilter?",id:"preprocfilter",level:3},{value:"Default",id:"default-33",level:4},{value:"proxyServerCredentials?",id:"proxyservercredentials",level:3},{value:"qrFormat?",id:"qrformat",level:3},{value:"Default",id:"default-34",level:4},{value:"qrLogSkip?",id:"qrlogskip",level:3},{value:"Default",id:"default-35",level:4},{value:"qrMax?",id:"qrmax",level:3},{value:"qrPopUpOnly?",id:"qrpopuponly",level:3},{value:"qrQuality?",id:"qrquality",level:3},{value:"Default",id:"default-36",level:4},{value:"qrRefreshS?",id:"qrrefreshs",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"qrTimeout?",id:"qrtimeout",level:3},{value:"Default",id:"default-37",level:4},{value:"raspi?",id:"raspi",level:3},{value:"Default",id:"default-38",level:4},{value:"resizable?",id:"resizable",level:3},{value:"Default",id:"default-39",level:4},{value:"restartOnCrash?",id:"restartoncrash",level:3},{value:"safeMode?",id:"safemode",level:3},{value:"Default",id:"default-40",level:4},{value:"screenshotOnInitializationBrowserError?",id:"screenshotoninitializationbrowsererror",level:3},{value:"Default",id:"default-41",level:4},{value:"sessionData?",id:"sessiondata",level:3},{value:"Deprecated",id:"deprecated-2",level:4},{value:"sessionDataBucketAuth?",id:"sessiondatabucketauth",level:3},{value:"sessionDataPath?",id:"sessiondatapath",level:3},{value:"sessionId?",id:"sessionid",level:3},{value:"Default",id:"default-42",level:4},{value:"skipBrokenMethodsCheck?",id:"skipbrokenmethodscheck",level:3},{value:"Default",id:"default-43",level:4},{value:"skipSessionSave?",id:"skipsessionsave",level:3},{value:"Default",id:"default-44",level:4},{value:"skipUpdateCheck?",id:"skipupdatecheck",level:3},{value:"Default",id:"default-45",level:4},{value:"stickerServerEndpoint?",id:"stickerserverendpoint",level:3},{value:"Default",id:"default-46",level:4},{value:"throwErrorOnTosBlock?",id:"throwerrorontosblock",level:3},{value:"throwOnExpiredSessionData?",id:"throwonexpiredsessiondata",level:3},{value:"Default",id:"default-47",level:4},{value:"useChrome?",id:"usechrome",level:3},{value:"Default",id:"default-48",level:4},{value:"useNativeProxy?",id:"usenativeproxy",level:3},{value:"Default",id:"default-49",level:4},{value:"useStealth?",id:"usestealth",level:3},{value:"Default",id:"default-50",level:4},{value:"viewport?",id:"viewport",level:3},{value:"height?",id:"height",level:4},{value:"Default",id:"default-51",level:5},{value:"width?",id:"width",level:4},{value:"Default",id:"default-52",level:5},{value:"waitForRipeSession?",id:"waitforripesession",level:3},{value:"waitForRipeSessionTimeout?",id:"waitforripesessiontimeout",level:3},{value:"Default",id:"default-53",level:4}];function h(e){const n={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-configobject",children:"Interface: ConfigObject"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aggressivegarbagecollection",children:"aggressiveGarbageCollection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"aggressiveGarbageCollection"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to true will run ",(0,i.jsx)(n.code,{children:"gc()"})," on before every command sent to the browser."]}),"\n",(0,i.jsx)(n.p,{children:"This is experimental and may not work or it may have unforeseen sideeffects."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"authtimeout",children:"authTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"authTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This determines how long the process should wait for the session authentication. If exceeded, checks if phone is out of reach (turned of or without internet connection) and throws an error. It does not relate to the amount of time spent waiting for a qr code scan (see [[qrTimeout]]). To have the system wait continuously, set this to ",(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"60"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"autoemoji",children:"autoEmoji?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"autoEmoji"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set the automatic emoji detection character. Set this to ",(0,i.jsx)(n.code,{children:"false"})," to disable auto emoji. Default is ",(0,i.jsx)(n.code,{children:":"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:":"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"autorefresh",children:(0,i.jsx)(n.del,{children:"autoRefresh?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"autoRefresh"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["THIS IS LOCKED TO ",(0,i.jsx)(n.code,{children:"true"})," AND CANNOT BE TURNED OFF. PLEASE SEE [[authTimeout]]"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will result in new QR codes being generated if the end user takes too long to scan the QR code."}),"\n",(0,i.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blockassets",children:"blockAssets?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"blockAssets"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will block all assets from loading onto the page. This may result in some load time improvements but also increases instability."}),"\n",(0,i.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blockcrashlogs",children:"blockCrashLogs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"blockCrashLogs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will block any network calls to crash log servers. This should keep anything you do under the radar."}),"\n",(0,i.jsx)(n.h4,{id:"default-4",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"browserrevision",children:"browserRevision?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"browserRevision"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This is the specific browser revision to be downlaoded and used. You can find browser revision strings here: ",(0,i.jsx)(n.a,{href:"http://omahaproxy.appspot.com/",children:"http://omahaproxy.appspot.com/"}),"\nLearn more about it here: ",(0,i.jsx)(n.a,{href:"https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browserfetcher",children:"https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browserfetcher"}),"\nIf you're having trouble with sending images, try '737027'.\nIf you go too far back things will start breaking !!!!!!\nNOTE: THIS WILL OVERRIDE useChrome and executablePath. ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"browserwsendpoint",children:"browserWSEndpoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"browserWSEndpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING."}),"\n",(0,i.jsx)(n.p,{children:"Learn more:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions",children:"https://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions"})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0",children:"https://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"bypasscsp",children:"bypassCSP?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"bypassCSP"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Disable cors see: ",(0,i.jsx)(n.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v3.0.4&show=api-pagesetbypasscspenabled",children:"https://pptr.dev/#?product=Puppeteer&version=v3.0.4&show=api-pagesetbypasscspenabled"})," If you are having an issue with sending media try to set this to true. Otherwise leave it set to false."]}),"\n",(0,i.jsx)(n.h4,{id:"default-5",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cacheenabled",children:"cacheEnabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cacheEnabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to false turn off the cache. This may improve memory usage."}),"\n",(0,i.jsx)(n.h4,{id:"default-6",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachedpatch",children:"cachedPatch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cachedPatch"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to ",(0,i.jsx)(n.code,{children:"true"})," will save a local copy of the patches.json file (as patches.ignore.data.json) which will be used in subsequent instantiations of the session. While the rest of the launch procedure is running, the library will fetch and save a recent version of the patches to ensure your patches don't go stale. This will be ignored if the cached patches are more than a day old."]}),"\n",(0,i.jsx)(n.h4,{id:"default-7",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"calltimeout",children:"callTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"callTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Amount of time (in ms) to wait for a client method (specifically methods that interact with the WA web session) to resolve. If a client method results takes longer than the timout value then it will result in a [[PageEvaluationTimeout]] error."}),"\n",(0,i.jsx)(n.p,{children:"If you get this error, it does not automatically mean that the method failed - it just stops your program from waiting for a client method to resolve."}),"\n",(0,i.jsx)(n.p,{children:"This is useful if you do not rely on the results of a client method (e.g the message ID)."}),"\n",(0,i.jsxs)(n.p,{children:["If set to ",(0,i.jsx)(n.code,{children:"0"}),", the process will wait indefinitely for a client method to resolve."]}),"\n",(0,i.jsx)(n.h4,{id:"default-8",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"0\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"chromiumargs",children:"chromiumArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"chromiumArgs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This allows you to pass any array of custom chrome/chromium argument strings to the puppeteer instance.\nYou can find all possible arguements ",(0,i.jsx)(n.a,{href:"https://peter.sh/experiments/chromium-command-line-switches/",children:"here"}),"."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"clouduploadoptions",children:"cloudUploadOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cloudUploadOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["REQUIRED IF ",(0,i.jsx)(n.code,{children:"messagePreprocessor"})," IS SET TO ",(0,i.jsx)(n.code,{children:"UPLOAD_CLOUD"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"This can be set via the config or the corresponding environment variables."}),"\n",(0,i.jsx)(n.h4,{id:"accesskeyid",children:"accessKeyId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"accessKeyId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"S3 compatible access key ID."}),"\n",(0,i.jsxs)(n.p,{children:["e.g: ",(0,i.jsx)(n.code,{children:"AKIAIOSFODNN7EXAMPLE"})," or ",(0,i.jsx)(n.code,{children:"GOOGTS7C7FUP3AIRVJTE2BCD"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_ACCESS_KEY_ID"})]}),"\n",(0,i.jsx)(n.h4,{id:"bucket",children:"bucket"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"bucket"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Bucket name"}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_BUCKET"})]}),"\n",(0,i.jsx)(n.h4,{id:"directory",children:"directory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"directory"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The directory strategy to use when uploading files. Or just set it to a custom directory string."}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_DIRECTORY"})]}),"\n",(0,i.jsx)(n.h4,{id:"headers",children:"headers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"headers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra headers to add to the upload request"}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"k"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"ignorehostaccount",children:"ignoreHostAccount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreHostAccount"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Ignore processing of messages that are sent by the host account itself"}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_IGNORE_HOST"})]}),"\n",(0,i.jsx)(n.h4,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:(0,i.jsx)(n.code,{children:"CLOUD_PROVIDERS"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AWS"}),", ",(0,i.jsx)(n.code,{children:"GCP"})," or ",(0,i.jsx)(n.code,{children:"WASABI"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_ACCESS_KEY_ID"})]}),"\n",(0,i.jsx)(n.h4,{id:"public",children:"public?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"public"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will make the uploaded file public"}),"\n",(0,i.jsx)(n.h4,{id:"region",children:"region?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"region"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Bucket region."}),"\n",(0,i.jsxs)(n.p,{children:["Not required for ",(0,i.jsx)(n.code,{children:"GCP"})," provider"]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_REGION"})]}),"\n",(0,i.jsx)(n.h4,{id:"secretaccesskey",children:"secretAccessKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"secretAccessKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"S3 compatible secret access key."}),"\n",(0,i.jsxs)(n.p,{children:["e.g ",(0,i.jsx)(n.code,{children:"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"})]}),"\n",(0,i.jsxs)(n.p,{children:["env: ",(0,i.jsx)(n.code,{children:"OW_CLOUD_SECRET_ACCESS_KEY"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"corsfix",children:"corsFix?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"corsFix"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will bypass web security. DO NOT DO THIS IF YOU DO NOT HAVE TO. CORS issue may arise when using a proxy."}),"\n",(0,i.jsx)(n.h4,{id:"default-9",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"customuseragent",children:"customUserAgent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"customUserAgent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You may set a custom user agent. However, due to recent developments, this is not really neccessary any more."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deletesessiondataonlogout",children:"deleteSessionDataOnLogout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"deleteSessionDataOnLogout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Deletes the session data file (if found) on logout event. This results in a quicker login when you restart the process."}),"\n",(0,i.jsx)(n.h4,{id:"default-10",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devtools",children:"devtools?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"devtools"}),": ",(0,i.jsx)(n.code,{children:"boolean"})," | ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:(0,i.jsx)(n.code,{children:"DevTools"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You can enable remote devtools by setting this to trye. If you set this to true there will be security on the devtools url.\nIf you want, you can also pass a username & password."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"disablespins",children:"disableSpins?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"disableSpins"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will simplify logs for use within docker containers by disabling spins (will still print raw messages)."}),"\n",(0,i.jsx)(n.h4,{id:"default-11",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"discord",children:"discord?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"discord"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Your Discord ID to get onto the sticker leaderboard!"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ensureheadfulintegrity",children:"ensureHeadfulIntegrity?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ensureHeadfulIntegrity"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Makes sure the headless session is usable even on first login.\nHeadful sessions are ususally only usable on reauthentication."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventmode",children:"eventMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"eventMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting listeners may not be your cup of tea. With eventMode, all [[SimpleListener]] events will be registered automatically and be filed via the built in Events Listener."}),"\n",(0,i.jsx)(n.p,{children:"This is useful because you can register/deregister the event listener as needed whereas the legacy method of setting callbacks are only be set once"}),"\n",(0,i.jsx)(n.h4,{id:"default-12",children:"Default"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"}),";"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"executablepath",children:"executablePath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"executablePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Some features, like video upload, do not work without a chrome instance. Set this to the path of your chrome instance or you can use ",(0,i.jsx)(n.code,{children:"useChrome:true"})," to automatically detect a chrome instance for you. Please note, this overrides ",(0,i.jsx)(n.code,{children:"useChrome"}),"."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ezqr",children:"ezqr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ezqr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Expose a URL where you can easily scan the qr code"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ghpatch",children:"ghPatch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ghPatch"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This will force the library to use the default cached raw github link for patches to shave a few hundred milliseconds from your launch time. If you use this option, you will need to wait about 5 minutes before trying out new patches."}),"\n",(0,i.jsx)(n.h4,{id:"default-13",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"headless",children:"headless?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"headless"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"By default, all instances of @open-wa/wa-automate are headless (i.e you don't see a chrome window open), you can set this to false to show the chrome/chromium window."}),"\n",(0,i.jsx)(n.h4,{id:"default-14",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnotificationlang",children:"hostNotificationLang?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"hostNotificationLang"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:(0,i.jsx)(n.code,{children:"NotificationLanguage"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The language of the host notification. See: ",(0,i.jsx)(n.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088",children:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"idcorrection",children:"idCorrection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"idCorrection"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["When true, the system will attempt to correct chatIds and groupChatIds. This means you can ignore ",(0,i.jsx)(n.code,{children:"@c.us"})," and ",(0,i.jsx)(n.code,{children:"@g.us"})," distinctions in some parameters."]}),"\n",(0,i.jsx)(n.h4,{id:"default-15",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ignorenuke",children:"ignoreNuke?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreNuke"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Don't implicitly determine if the host logged out."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"indocker",children:"inDocker?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"inDocker"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will try infer as many config variables as possible from the environment variables. The format of the variables are as below:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"sessionData ==> WA_SESSION_DATA\nsessionDataPath ==> WA_SESSION_DATA_PATH\nsessionId ==> WA_SESSION_ID\ncustomUserAgent ==> WA_CUSTOM_USER_AGENT\nblockCrashLogs ==> WA_BLOCK_CRASH_LOGS\nblockAssets ==> WA_BLOCK_ASSETS\ncorsFix ==> WA_CORS_FIX\ncacheEnabled ==> WA_CACHE_ENABLED\nheadless ==> WA_HEADLESS\nqrTimeout ==> WA_QR_TIMEOUT\nuseChrome ==> WA_USE_CHROME\nqrLogSkip ==> WA_QR_LOG_SKIP\ndisableSpins ==> WA_DISABLE_SPINS\nlogConsole ==> WA_LOG_CONSOLE\nlogConsoleErrors==> WA_LOG_CONSOLE_ERRORS\nauthTimeout ==> WA_AUTH_TIMEOUT\nsafeMode ==> WA_SAFE_MODE\nskipSessionSave ==> WA_SKIP_SESSION_SAVE\npopup ==> WA_POPUP \nlicensekey ==> WA_LICENSE_KEY \n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-16",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"keepupdated",children:"keepUpdated?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"keepUpdated"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["[ALPHA FEATURE - ONLY IMPLEMENTED FOR TESTING - DO NOT USE IN PRODUCTION YET]\nSetting this to true will result in the library making sure it is always starting with the latest version of itself. This overrides ",(0,i.jsx)(n.code,{children:"skipUpdateCheck"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-17",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killclientonlogout",children:"killClientOnLogout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killClientOnLogout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Kill the client when a logout is detected"}),"\n",(0,i.jsx)(n.h4,{id:"default-18",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessonban",children:"killProcessOnBan?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnBan"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:['If set to true, the system will kill the whole node process when a "TEMPORARY BAN" is detected. This is useful to prevent hanging processes.\nIt is ',(0,i.jsx)(n.code,{children:"true"})," by default because it is a very rare event and it is better to kill the process than to leave it hanging."]}),"\n",(0,i.jsx)(n.h4,{id:"default-19",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessonbrowserclose",children:"killProcessOnBrowserClose?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnBrowserClose"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting this to ",(0,i.jsx)(n.code,{children:"true"})," will kill the whole process when the client is disconnected from the page or if the browser is closed."]}),"\n",(0,i.jsx)(n.h4,{id:"default-20",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"killprocessontimeout",children:"killProcessOnTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"killProcessOnTimeout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set to true, the system will kill the whole node process when either an [[authTimeout]] or a [[qrTimeout]] has been reached. This is useful to prevent hanging processes."}),"\n",(0,i.jsx)(n.h4,{id:"default-21",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"legacy",children:"legacy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"legacy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"As the library is constantly evolving, some parts will be replaced with more efficient and improved code. In some of the infinite edge cases these new changes may not work for you. Set this to true to roll back on 'late beta' features. The reason why legacy is false by default is that in order for features to be tested they have to be released and used by everyone to find the edge cases and fix them."}),"\n",(0,i.jsx)(n.h4,{id:"default-22",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"licensekey",children:"licenseKey?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"licenseKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In order to unlock the functionality to send texts to unknown numbers, you need a License key.\nOne License Key is valid for each number. Each License Key starts from \xa35 per month."}),"\n",(0,i.jsx)(n.p,{children:"Please check README for instructions on how to get a license key."}),"\n",(0,i.jsx)(n.p,{children:"Notes:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"You can change the number assigned to that License Key at any time, just message me the new number on the private discord channel."}),"\n",(0,i.jsx)(n.li,{children:"In order to cancel your License Key, simply stop your membership."}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linkcode",children:"linkCode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"linkCode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"There is a new way to login to your host account by entering a link code after a confirmation step from the host account device. In order to use this feature you MUST set the host account number as a string or number beforehand as a property of the config object."}),"\n",(0,i.jsx)(n.p,{children:"e.g"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"linkCode: '1234567890'\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linkparser",children:"linkParser?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"linkParser"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The URL of your instance of ",(0,i.jsx)(n.a,{href:"https://github.com/RemiixInc/meta-grabber-serverless",children:"serverless meta grabber"})," by ",(0,i.jsx)(n.a,{href:"https://github.com/RemiixInc",children:"RemiixInc"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["default: ",(0,i.jsx)(n.code,{children:"https://link.openwa.cloud/api"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconsole",children:"logConsole?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logConsole"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, this will log any console messages from the browser."}),"\n",(0,i.jsx)(n.h4,{id:"default-23",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconsoleerrors",children:"logConsoleErrors?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logConsoleErrors"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, this will log any error messages from the browser instance"}),"\n",(0,i.jsx)(n.h4,{id:"default-24",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logdebuginfoasobject",children:"logDebugInfoAsObject?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logDebugInfoAsObject"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Setting ",(0,i.jsx)(n.code,{children:"this"})," to true will replace the ",(0,i.jsx)(n.code,{children:"console.table"})," with a stringified logging of the debug info object instead. This would be useful to set for smaller terminal windows. If ",(0,i.jsx)(n.code,{children:"disableSpins"})," is ",(0,i.jsx)(n.code,{children:"true"})," then this will also be ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-25",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logfile",children:"logFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logFile"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the system will automatically create a log of all processes relating to actions sent to the web session."}),"\n",(0,i.jsx)(n.p,{children:"The location of the file will be relative to the process directory (pd)"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"[pd]/[sessionId]/[start timestamp].log"})}),"\n",(0,i.jsx)(n.h4,{id:"default-26",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"loginternalevents",children:"logInternalEvents?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logInternalEvents"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This will make the library log all internal wa web events to the console. This is useful for debugging purposes. DO NOT TURN THIS ON UNLESS ASKED TO."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logging",children:"logging?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logging"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",children:(0,i.jsx)(n.code,{children:"ConfigLogTransport"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An array of ",(0,i.jsx)(n.a,{href:"https://github.com/winstonjs/winston/blob/master/docs/transports.md#additional-transports",children:"winston"})," logging transport configurations."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/open-wa/wa-automate-nodejs/discussions/2373",children:"Check this discussion to see how to set up logging"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxchats",children:"maxChats?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxChats"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the maximum amount of chats to be present in a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxmessages",children:"maxMessages?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxMessages"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the maximum amount of messages to be present in a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"messagepreprocessor",children:"messagePreprocessor?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"messagePreprocessor"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set a preprocessor, or multiple chained preprocessors, for messages. See ",(0,i.jsx)(n.a,{href:"/",children:"MPConfigType"})," for more info."]}),"\n",(0,i.jsxs)(n.p,{children:["options: ",(0,i.jsx)(n.code,{children:"SCRUB"}),", ",(0,i.jsx)(n.code,{children:"BODY_ONLY"}),", ",(0,i.jsx)(n.code,{children:"AUTO_DECRYPT"}),", ",(0,i.jsx)(n.code,{children:"AUTO_DECRYPT_SAVE"}),", ",(0,i.jsx)(n.code,{children:"UPLOAD_CLOUD"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-27",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multidevice",children:"multiDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"multiDevice"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Please note that multi-device is still in beta so a lot of things may not work. It is HIGHLY suggested to NOT use this in production!!!!"}),"\n",(0,i.jsx)(n.p,{children:"Set this to true if you're using the multidevice beta."}),"\n",(0,i.jsx)(n.h4,{id:"default-28",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.admonition,{type:"danger",children:(0,i.jsxs)(n.p,{children:["Some features (e.g [[sendLinkWithAutoPreview]]) ",(0,i.jsx)(n.strong,{children:"do not"})," work with multi-device beta. Check ",(0,i.jsxs)(n.a,{href:"#",children:["this ",(0,i.jsx)(n.code,{children:"api"})]}),"."]})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onerror",children:"onError?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"onError"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:(0,i.jsx)(n.code,{children:"OnError"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What to do when an error is detected on a client method."}),"\n",(0,i.jsx)(n.h4,{id:"default-29",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"OnError.NOTHING"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oortimeout",children:"oorTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"oorTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"phoneIsOutOfReach check timeout"}),"\n",(0,i.jsx)(n.h4,{id:"default-30",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"60"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pqueuedefault",children:"pQueueDefault?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pQueueDefault"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default pqueue options applied to all listeners that can take pqueue options as a second optional parameter. For now, this only includes ",(0,i.jsx)(n.code,{children:"onMessage"})," and ",(0,i.jsx)(n.code,{children:"onAnyMessage"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["See: ",(0,i.jsx)(n.a,{href:"https://github.com/sindresorhus/p-queue#options",children:"https://github.com/sindresorhus/p-queue#options"})]}),"\n",(0,i.jsx)(n.p,{children:"Example: process 5 events within every 3 seconds window. Make sure to only process at most 2 at any one time. Make sure there is at least 100ms between each event processing."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:" { \n intervalCap: 5, //process 5 events\n interval: 3000, //within every three second window\n concurrency: 2, //make sure to process, at most, 2 events at any one time\n timeout: 100, //make sure there is a 100ms gap between each event processing.\n carryoverConcurrencyCount: true //If there are more than 5 events in that period, process them within the next 3 second period. Make sure this is always set to true!!!\n }\n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-31",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"popup",children:"popup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"popup"}),": ",(0,i.jsx)(n.code,{children:"number"})," | ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will open a browser window where you will see basic event logs and QR codes to authenticate the session. Usually it will open on port 3000. It can also be set to a preferred port."}),"\n",(0,i.jsx)(n.p,{children:"You can also get the QR code png at (if localhost and port 3000):"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"http://localhost:3000/qr"})}),"\n",(0,i.jsx)(n.p,{children:"or if you have multiple session:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"http://localhost:3000/qr?sessionId=[sessionId]"})}),"\n",(0,i.jsx)(n.h4,{id:"default-32",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false | 3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"preprocfilter",children:"preprocFilter?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"preprocFilter"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set an array filter to be used with messagePreprocessor to limit which messages are preprocessed."}),"\n",(0,i.jsxs)(n.p,{children:["E.g if you want to scrub all messages that are not from a group, you can do the following:\n",(0,i.jsx)(n.code,{children:'"m=>!m.isGroupMsg"'})]}),"\n",(0,i.jsx)(n.h4,{id:"default-33",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"undefined"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"proxyservercredentials",children:"proxyServerCredentials?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"proxyServerCredentials"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:(0,i.jsx)(n.code,{children:"ProxyServerCredentials"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If sent, adds a call to waPage.authenticate with those credentials. Set ",(0,i.jsx)(n.code,{children:"corsFix"})," to true if using a proxy results in CORS errors."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrformat",children:"qrFormat?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrFormat"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:(0,i.jsx)(n.code,{children:"QRFormat"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The output format of the qr code. ",(0,i.jsx)(n.code,{children:"png"}),", ",(0,i.jsx)(n.code,{children:"jpeg"})," or ",(0,i.jsx)(n.code,{children:"webm"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-34",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"png"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrlogskip",children:"qrLogSkip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrLogSkip"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, skips logging the QR Code to the console."}),"\n",(0,i.jsx)(n.h4,{id:"default-35",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrmax",children:"qrMax?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrMax"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Automatically kill the process after a set amount of qr codes"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrpopuponly",children:"qrPopUpOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrPopUpOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This needs to be used in conjuction with ",(0,i.jsx)(n.code,{children:"popup"}),", if ",(0,i.jsx)(n.code,{children:"popup"})," is not true or a number (representing a desired port) then this will not work."]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will make sure that only the qr code png is served via the web server. This is useful if you do not need the whole status page."}),"\n",(0,i.jsxs)(n.p,{children:["As mentioned in ",(0,i.jsx)(n.a,{href:"#popup",children:"popup"}),", the url for the qr code is ",(0,i.jsx)(n.code,{children:"http://localhost:3000/qr"})," if the port is 3000."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrquality",children:"qrQuality?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrQuality"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:(0,i.jsx)(n.code,{children:"QRQuality"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The output quality of the qr code during authentication. This can be any increment of 0.1 from 0.1 to 1.0."}),"\n",(0,i.jsx)(n.h4,{id:"default-36",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"1.0"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrrefreshs",children:(0,i.jsx)(n.del,{children:"qrRefreshS?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrRefreshS"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsx)(n.p,{children:"This now has no effect"}),"\n",(0,i.jsx)(n.p,{children:"This determines the interval at which to refresh the QR code. By default, WA updates the qr code every 18-19 seconds so make sure this value is set to UNDER 18 seconds!!"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"qrtimeout",children:"qrTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"qrTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This determines how long the process should wait for a QR code to be scanned before killing the process entirely. To have the system wait continuously, set this to ",(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"default-37",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"60\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"raspi",children:"raspi?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"raspi"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set this to ",(0,i.jsx)(n.code,{children:"true"})," to make the library work on Raspberry Pi OS."]}),"\n",(0,i.jsx)(n.p,{children:"Make sure to run the following command before running the library the first time:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"> sudo apt update -y && sudo apt install chromium-browser chromium-codecs-ffmpeg -y && sudo apt upgrade\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you're using the CLI, you can set this value to ",(0,i.jsx)(n.code,{children:"true"})," by adding the following flag to the CLI command"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"> npx @open-wa/wa-automate ... --raspi\n"})}),"\n",(0,i.jsx)(n.h4,{id:"default-38",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resizable",children:"resizable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"resizable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Syncs the viewport size with the window size which is how normal browsers act. Only relevant when ",(0,i.jsx)(n.code,{children:"headless: false"})," and this overrides ",(0,i.jsx)(n.code,{children:"viewport"})," config."]}),"\n",(0,i.jsx)(n.h4,{id:"default-39",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"true"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartoncrash",children:"restartOnCrash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"restartOnCrash"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set, the program will try to recreate itself when the page crashes. You have to pass the function that you want called upon restart. Please note that when the page crashes you may miss some messages.\nE.g:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:"const start = async (client: Client) => {...}\ncreate({\n...\nrestartOnCrash: start,\n...\n})\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"safemode",children:"safeMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"safeMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, client will check if the page is valid before each command. If page is not valid, it will throw an error."}),"\n",(0,i.jsx)(n.h4,{id:"default-40",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"screenshotoninitializationbrowsererror",children:"screenshotOnInitializationBrowserError?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"screenshotOnInitializationBrowserError"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["When true, this option will take a screenshot of the browser when an unexpected error occurs within the browser during ",(0,i.jsx)(n.code,{children:"create"})," initialization. The path will be ",(0,i.jsx)(n.code,{children:"[working directory]/logs/[session ID]/[start timestamp]/[timestamp].jpg"})]}),"\n",(0,i.jsx)(n.h4,{id:"default-41",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondata",children:(0,i.jsx)(n.del,{children:"sessionData?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionData"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,i.jsx)(n.code,{children:"Base64"})})," | ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:(0,i.jsx)(n.code,{children:"SessionData"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,i.jsx)(n.p,{children:"The authentication object (as a JSON object or a base64 encoded string) that is required to migrate a session from one instance to another or to just restart an existing instance.\nThis sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event."}),"\n",(0,i.jsx)(n.p,{children:"You can capture the event like so:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:"import {create, ev} from '@open-wa/wa-automate';\n\n ev.on('sessionData.**', async (sessionData, sessionId) =>{\n console.log(sessionId, sessionData)\n })\n\n//or as base64 encoded string\n\n ev.on('sessionDataBase64.**', async (sessionDatastring, sessionId) =>{\n console.log(sessionId, sessionDatastring)\n })\n"})}),"\n",(0,i.jsx)(n.p,{children:"NOTE: You can set sessionData as an evironmental variable also! The variable name has to be [sessionId (default = 'session) in all caps]_DATA_JSON. You have to make sure to surround your session data with single quotes to maintain the formatting."}),"\n",(0,i.jsx)(n.p,{children:"For example:"}),"\n",(0,i.jsx)(n.p,{children:"sessionId = 'session'"}),"\n",(0,i.jsx)(n.p,{children:"To set env var:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:" export SESSION_DATA_JSON=`...`\n"})}),"\n",(0,i.jsxs)(n.p,{children:["where ... is copied from session.data.json this will be a string most likley starting in ",(0,i.jsx)(n.code,{children:"ey..."})," and ending with ",(0,i.jsx)(n.code,{children:"=="})]}),"\n",(0,i.jsx)(n.p,{children:"Setting the sessionData in the environmental variable will override the sessionData object in the config."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondatabucketauth",children:"sessionDataBucketAuth?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionDataBucketAuth"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessiondatapath",children:"sessionDataPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionDataPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The path relative to the current working directory (i.e where you run the command to start your process). This will be used to store and read your ",(0,i.jsx)(n.code,{children:".data.json"})," files. defualt to ''"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sessionid",children:"sessionId?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sessionId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This is the name of the session. You have to make sure that this is unique for every session."}),"\n",(0,i.jsx)(n.h4,{id:"default-42",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"session"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipbrokenmethodscheck",children:"skipBrokenMethodsCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipBrokenMethodsCheck"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If set to true, skipBrokenMethodsCheck will bypass the health check before startup. It is highly suggested to not set this to true."}),"\n",(0,i.jsx)(n.h4,{id:"default-43",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipsessionsave",children:"skipSessionSave?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipSessionSave"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the process will not save a data.json file. This means that sessions will not be saved and you will need to pass sessionData as a config param or create the session data.json file yourself"}),"\n",(0,i.jsx)(n.h4,{id:"default-44",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"skipupdatecheck",children:"skipUpdateCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"skipUpdateCheck"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If set to true, ",(0,i.jsx)(n.code,{children:"skipUpdateCheck"})," will bypass the latest version check. This saves some time on boot (around 150 ms)."]}),"\n",(0,i.jsx)(n.h4,{id:"default-45",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stickerserverendpoint",children:"stickerServerEndpoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"stickerServerEndpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Redundant until self-hostable sticker server is available."}),"\n",(0,i.jsx)(n.h4,{id:"default-46",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"https://sticker-api.openwa.dev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throwerrorontosblock",children:"throwErrorOnTosBlock?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"throwErrorOnTosBlock"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Setting this to true will throw an error if a session is not able to get a QR code or is unable to restart a session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throwonexpiredsessiondata",children:"throwOnExpiredSessionData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"throwOnExpiredSessionData"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This will make the ",(0,i.jsx)(n.code,{children:"create"})," command return ",(0,i.jsx)(n.code,{children:"false"})," if the detected session data is expired."]}),"\n",(0,i.jsx)(n.p,{children:"This will mean, the process will not attempt to automatically get a new QR code."}),"\n",(0,i.jsx)(n.h4,{id:"default-47",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usechrome",children:"useChrome?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useChrome"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath."}),"\n",(0,i.jsx)(n.h4,{id:"default-48",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usenativeproxy",children:"useNativeProxy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useNativeProxy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Some sessions may experience issues with sending media when using proxies. Using the native proxy system instead of the recommended 3rd party library may fix these issues."}),"\n",(0,i.jsx)(n.h4,{id:"default-49",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usestealth",children:"useStealth?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"useStealth"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This flag allows you to disable or enable the use of the puppeteer stealth plugin. It is a good idea to use it, however it can cause issues sometimes. Set this to false if you are experiencing ",(0,i.jsx)(n.code,{children:"browser.setMaxListeneres"})," issue. For now the default for this is false."]}),"\n",(0,i.jsx)(n.h4,{id:"default-50",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewport",children:"viewport?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"viewport"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g ",(0,i.jsx)(n.code,{children:"--viewport 1920x1080"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"height",children:"height?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"height"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Page height in pixels"}),"\n",(0,i.jsx)(n.h5,{id:"default-51",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"900"})}),"\n",(0,i.jsx)(n.h4,{id:"width",children:"width?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"width"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Page width in pixels"}),"\n",(0,i.jsx)(n.h5,{id:"default-52",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"1440"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"waitforripesession",children:"waitForRipeSession?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"waitForRipeSession"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["wait for a valid headful session. Not required in recent versions.\ndefault: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"waitforripesessiontimeout",children:"waitForRipeSessionTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"waitForRipeSessionTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This determines how long the process should wait for a session to load fully before continuing the launch process.\nSet this to 0 to wait forever. Default is 5 seconds."}),"\n",(0,i.jsx)(n.h4,{id:"default-53",children:"Default"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"5\n"})})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>t});var i=s(6540);const l={},o=i.createContext(l);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e0f73c7.14c416b8.js b/assets/js/0e0f73c7.14c416b8.js deleted file mode 100644 index c37372512e..0000000000 --- a/assets/js/0e0f73c7.14c416b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16],{3136:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=r(4848),t=r(8453);const i={},s="Enumeration: QRFormat",c={id:"reference/api/model/config/enumerations/QRFormat",title:"Enumeration: QRFormat",description:"The different types of qr code output.",source:"@site/docs/reference/api/model/config/enumerations/QRFormat.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/QRFormat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError"},next:{title:"Enumeration: QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality"}},a={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"JPEG",id:"jpeg",level:3},{value:"PNG",id:"png",level:3},{value:"WEBM",id:"webm",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"enumeration-qrformat",children:"Enumeration: QRFormat"}),"\n",(0,o.jsx)(n.p,{children:"The different types of qr code output."}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"jpeg",children:"JPEG"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"JPEG"}),": ",(0,o.jsx)(n.code,{children:'"jpeg"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"png",children:"PNG"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"PNG"}),": ",(0,o.jsx)(n.code,{children:'"png"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"webm",children:"WEBM"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"WEBM"}),": ",(0,o.jsx)(n.code,{children:'"webm"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var o=r(6540);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e0f73c7.5ad660fc.js b/assets/js/0e0f73c7.5ad660fc.js new file mode 100644 index 0000000000..ca8331f6d1 --- /dev/null +++ b/assets/js/0e0f73c7.5ad660fc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16],{3136:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=r(4848),t=r(8453);const i={},s="Enumeration: QRFormat",c={id:"reference/api/model/config/enumerations/QRFormat",title:"Enumeration: QRFormat",description:"The different types of qr code output.",source:"@site/docs/reference/api/model/config/enumerations/QRFormat.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/QRFormat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError"},next:{title:"Enumeration: QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality"}},a={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"JPEG",id:"jpeg",level:3},{value:"PNG",id:"png",level:3},{value:"WEBM",id:"webm",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"enumeration-qrformat",children:"Enumeration: QRFormat"})}),"\n",(0,o.jsx)(n.p,{children:"The different types of qr code output."}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"jpeg",children:"JPEG"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"JPEG"}),": ",(0,o.jsx)(n.code,{children:'"jpeg"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"png",children:"PNG"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"PNG"}),": ",(0,o.jsx)(n.code,{children:'"png"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"webm",children:"WEBM"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"WEBM"}),": ",(0,o.jsx)(n.code,{children:'"webm"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var o=r(6540);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.37d1e6f6.js b/assets/js/0e384e19.37d1e6f6.js deleted file mode 100644 index ac24224cc7..0000000000 --- a/assets/js/0e384e19.37d1e6f6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3976],{619:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var o=e(4848),s=e(8453);const i={position:0,sidebar_position:0,title:"Introduction"},r="Introduction",c={id:"intro",title:"Introduction",description:"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{position:0,sidebar_position:0,title:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Glossary",permalink:"/docs/concepts/glossary"}},l={},a=[];function d(n){const t={h1:"h1",li:"li",p:"p",ul:"ul",...(0,s.R)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"introduction",children:"Introduction"}),"\n",(0,o.jsx)(t.p,{children:"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account."}),"\n",(0,o.jsx)(t.p,{children:"There are multiple ways to run this library:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"CLI (npx/docker)"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"npx"}),"\n",(0,o.jsx)(t.li,{children:"docker"}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsx)(t.p,{children:"Your own code"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"Locally"}),"\n",(0,o.jsx)(t.li,{children:"Socketed"}),"\n"]}),"\n"]}),"\n"]})]})}function u(n={}){const{wrapper:t}={...(0,s.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>r,x:()=>c});var o=e(6540);const s={},i=o.createContext(s);function r(n){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function c(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),o.createElement(i.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.ba1fb42e.js b/assets/js/0e384e19.ba1fb42e.js new file mode 100644 index 0000000000..c0cae33cc7 --- /dev/null +++ b/assets/js/0e384e19.ba1fb42e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3976],{619:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var o=t(4848),s=t(8453);const i={position:0,sidebar_position:0,title:"Introduction"},r="Introduction",c={id:"intro",title:"Introduction",description:"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{position:0,sidebar_position:0,title:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Glossary",permalink:"/docs/concepts/glossary"}},l={},a=[];function d(n){const e={h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,s.R)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.header,{children:(0,o.jsx)(e.h1,{id:"introduction",children:"Introduction"})}),"\n",(0,o.jsx)(e.p,{children:"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account."}),"\n",(0,o.jsx)(e.p,{children:"There are multiple ways to run this library:"}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsxs)(e.li,{children:["\n",(0,o.jsx)(e.p,{children:"CLI (npx/docker)"}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsx)(e.li,{children:"npx"}),"\n",(0,o.jsx)(e.li,{children:"docker"}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["\n",(0,o.jsx)(e.p,{children:"Your own code"}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsx)(e.li,{children:"Locally"}),"\n",(0,o.jsx)(e.li,{children:"Socketed"}),"\n"]}),"\n"]}),"\n"]})]})}function u(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},8453:(n,e,t)=>{t.d(e,{R:()=>r,x:()=>c});var o=t(6540);const s={},i=o.createContext(s);function r(n){const e=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),o.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/1025625c.65d9212c.js b/assets/js/1025625c.65d9212c.js deleted file mode 100644 index 53819da17c..0000000000 --- a/assets/js/1025625c.65d9212c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1207],{1649:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var r=n(4848),i=n(8453);const o={},c="Interface: GroupChatCreationParticipantAddResponse",s={id:"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",title:"Interface: GroupChatCreationParticipantAddResponse",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat"},next:{title:"Interface: GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"code",id:"code",level:3},{value:"invite_code?",id:"invite_code",level:3},{value:"invite_code_exp?",id:"invite_code_exp",level:3}];function p(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-groupchatcreationparticipantaddresponse",children:"Interface: GroupChatCreationParticipantAddResponse"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"code",children:"code"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"code"}),": ",(0,r.jsx)(t.code,{children:"200"})," | ",(0,r.jsx)(t.code,{children:"400"})," | ",(0,r.jsx)(t.code,{children:"403"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The resultant status code for adding the participant."}),"\n",(0,r.jsx)(t.p,{children:"200 if the participant was added successfully during the creation of the group."}),"\n",(0,r.jsxs)(t.p,{children:["403 if the participant does not allow their account to be added to group chats. If you receive a 403, you will also get an ",(0,r.jsx)(t.code,{children:"invite_code"})," and ",(0,r.jsx)(t.code,{children:"invite_code_exp"})]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"invite_code",children:"invite_code?"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"optional"})," ",(0,r.jsx)(t.strong,{children:"invite_code"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["If the participant is not allowed to be added to group chats due to their privacy settings, you will receive an ",(0,r.jsx)(t.code,{children:"invite_code"})," which you can send to them via a text."]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"invite_code_exp",children:"invite_code_exp?"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"optional"})," ",(0,r.jsx)(t.strong,{children:"invite_code_exp"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The expiry ts of the invite_code. It is a number wrapped in a string, in order to get the proper time you can use this:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-javascript",children:" new Date(Number(invite_code_exp)*1000)\n"})})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>s});var r=n(6540);const i={},o=r.createContext(i);function c(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1025625c.d2a2c419.js b/assets/js/1025625c.d2a2c419.js new file mode 100644 index 0000000000..62566751c7 --- /dev/null +++ b/assets/js/1025625c.d2a2c419.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1207],{1649:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(4848),i=n(8453);const o={},c="Interface: GroupChatCreationParticipantAddResponse",a={id:"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",title:"Interface: GroupChatCreationParticipantAddResponse",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat"},next:{title:"Interface: GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"code",id:"code",level:3},{value:"invite_code?",id:"invite_code",level:3},{value:"invite_code_exp?",id:"invite_code_exp",level:3}];function p(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-groupchatcreationparticipantaddresponse",children:"Interface: GroupChatCreationParticipantAddResponse"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"code",children:"code"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"code"}),": ",(0,r.jsx)(t.code,{children:"200"})," | ",(0,r.jsx)(t.code,{children:"400"})," | ",(0,r.jsx)(t.code,{children:"403"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The resultant status code for adding the participant."}),"\n",(0,r.jsx)(t.p,{children:"200 if the participant was added successfully during the creation of the group."}),"\n",(0,r.jsxs)(t.p,{children:["403 if the participant does not allow their account to be added to group chats. If you receive a 403, you will also get an ",(0,r.jsx)(t.code,{children:"invite_code"})," and ",(0,r.jsx)(t.code,{children:"invite_code_exp"})]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"invite_code",children:"invite_code?"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"optional"})," ",(0,r.jsx)(t.strong,{children:"invite_code"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["If the participant is not allowed to be added to group chats due to their privacy settings, you will receive an ",(0,r.jsx)(t.code,{children:"invite_code"})," which you can send to them via a text."]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"invite_code_exp",children:"invite_code_exp?"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"optional"})," ",(0,r.jsx)(t.strong,{children:"invite_code_exp"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The expiry ts of the invite_code. It is a number wrapped in a string, in order to get the proper time you can use this:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-javascript",children:" new Date(Number(invite_code_exp)*1000)\n"})})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var r=n(6540);const i={},o=r.createContext(i);function c(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1061d0cb.31cb50a5.js b/assets/js/1061d0cb.31cb50a5.js new file mode 100644 index 0000000000..8a3c8fa2fd --- /dev/null +++ b/assets/js/1061d0cb.31cb50a5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4940],{4744:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var a=s(4848),n=s(8453);const o={},i="Capturing the session data",r={id:"configuration/capture-sd",title:"Capturing the session data",description:"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.",source:"@site/docs/configuration/capture-sd.md",sourceDirName:"configuration",slug:"/configuration/capture-sd",permalink:"/docs/configuration/capture-sd",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/capture-sd.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Capturing QR Code",permalink:"/docs/configuration/capture-qr"},next:{title:"Launch Events",permalink:"/docs/configuration/launch-events"}},d={},c=[];function u(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"capturing-the-session-data",children:"Capturing the session data"})}),"\n",(0,a.jsxs)(t.p,{children:["By default, the session data is saved as a ",(0,a.jsx)(t.code,{children:"[sessionId].data.json"})," file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\nconst fs = require('fs');\n\nev.on('sessionData.**', async (sessionData, sessionId) => {\n //do something with sessionData and sessionId\n});\n"})})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>r});var a=s(6540);const n={},o=a.createContext(n);function i(e){const t=a.useContext(o);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),a.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1061d0cb.adab7b6c.js b/assets/js/1061d0cb.adab7b6c.js deleted file mode 100644 index 756c84a0f1..0000000000 --- a/assets/js/1061d0cb.adab7b6c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4940],{4744:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var a=s(4848),n=s(8453);const o={},i="Capturing the session data",r={id:"configuration/capture-sd",title:"Capturing the session data",description:"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.",source:"@site/docs/configuration/capture-sd.md",sourceDirName:"configuration",slug:"/configuration/capture-sd",permalink:"/docs/configuration/capture-sd",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/capture-sd.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Capturing QR Code",permalink:"/docs/configuration/capture-qr"},next:{title:"Launch Events",permalink:"/docs/configuration/launch-events"}},c={},d=[];function u(e){const t={code:"code",h1:"h1",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"capturing-the-session-data",children:"Capturing the session data"}),"\n",(0,a.jsxs)(t.p,{children:["By default, the session data is saved as a ",(0,a.jsx)(t.code,{children:"[sessionId].data.json"})," file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\nconst fs = require('fs');\n\nev.on('sessionData.**', async (sessionData, sessionId) => {\n //do something with sessionData and sessionId\n});\n"})})]})}function l(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>r});var a=s(6540);const n={},o=a.createContext(n);function i(e){const t=a.useContext(o);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),a.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/11347dcd.1a6e3587.js b/assets/js/11347dcd.1a6e3587.js deleted file mode 100644 index e88d2049fb..0000000000 --- a/assets/js/11347dcd.1a6e3587.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7180],{5689:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var r=t(4848),s=t(8453);const i={},o="Enumeration: Status",a={id:"reference/api/model/enumerations/Status",title:"Enumeration: Status",description:"Client status",source:"@site/docs/reference/api/model/enumerations/Status.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/Status",permalink:"/docs/reference/api/model/enumerations/Status",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/Status.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: STATE",permalink:"/docs/reference/api/model/enumerations/STATE"},next:{title:"api/model/errors",permalink:"/docs/reference/api/model/errors/"}},c={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTHENTICATING",id:"authenticating",level:3},{value:"INITIALIZING",id:"initializing",level:3},{value:"READY",id:"ready",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-status",children:"Enumeration: Status"}),"\n",(0,r.jsx)(n.p,{children:"Client status"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"authenticating",children:"AUTHENTICATING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATING"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initializing",children:"INITIALIZING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"INITIALIZING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ready",children:"READY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"READY"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/11347dcd.53e5a85c.js b/assets/js/11347dcd.53e5a85c.js new file mode 100644 index 0000000000..76614642ef --- /dev/null +++ b/assets/js/11347dcd.53e5a85c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7180],{5689:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=t(4848),s=t(8453);const i={},o="Enumeration: Status",a={id:"reference/api/model/enumerations/Status",title:"Enumeration: Status",description:"Client status",source:"@site/docs/reference/api/model/enumerations/Status.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/Status",permalink:"/docs/reference/api/model/enumerations/Status",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/Status.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: STATE",permalink:"/docs/reference/api/model/enumerations/STATE"},next:{title:"api/model/errors",permalink:"/docs/reference/api/model/errors/"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTHENTICATING",id:"authenticating",level:3},{value:"INITIALIZING",id:"initializing",level:3},{value:"READY",id:"ready",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-status",children:"Enumeration: Status"})}),"\n",(0,r.jsx)(n.p,{children:"Client status"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"authenticating",children:"AUTHENTICATING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATING"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initializing",children:"INITIALIZING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"INITIALIZING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ready",children:"READY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"READY"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1454731d.67611782.js b/assets/js/1454731d.67611782.js deleted file mode 100644 index bb67a9caff..0000000000 --- a/assets/js/1454731d.67611782.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[314],{5773:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var i=r(4848),s=r(8453);const t={},l="Class: NoOpTransport",d={id:"reference/logging/custom_transport/classes/NoOpTransport",title:"Class: NoOpTransport",description:"Extends",source:"@site/docs/reference/logging/custom_transport/classes/NoOpTransport.md",sourceDirName:"reference/logging/custom_transport/classes",slug:"/reference/logging/custom_transport/classes/NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/classes/NoOpTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport"},next:{title:"logging/logging",permalink:"/docs/reference/logging/logging/"}},c={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new NoOpTransport()",id:"new-nooptransport",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"closed",id:"closed",level:3},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"destroyed",id:"destroyed",level:3},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"errored",id:"errored",level:3},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"format?",id:"format",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"handleExceptions?",id:"handleexceptions",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"handleRejections?",id:"handlerejections",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"level?",id:"level",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"silent?",id:"silent",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"writable",id:"writable",level:3},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"writableCorked",id:"writablecorked",level:3},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"writableEnded",id:"writableended",level:3},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"writableFinished",id:"writablefinished",level:3},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"writableHighWaterMark",id:"writablehighwatermark",level:3},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"writableLength",id:"writablelength",level:3},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"writableNeedDrain",id:"writableneeddrain",level:3},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"writableObjectMode",id:"writableobjectmode",level:3},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Methods",id:"methods",level:2},{value:"_construct()?",id:"_construct",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"_destroy()",id:"_destroy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"_final()",id:"_final",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"_write()",id:"_write",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"_writev()?",id:"_writev",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"addListener(event, listener)",id:"addlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Since",id:"since-11",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-8",level:5},{value:"Since",id:"since-12",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Since",id:"since-13",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Since",id:"since-14",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Since",id:"since-15",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Since",id:"since-16",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"close()?",id:"close",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"cork()",id:"cork",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-18",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"emit()",id:"emit",level:3},{value:"emit(event)",id:"emitevent",level:4},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Since",id:"since-19",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"emit(event)",id:"emitevent-1",level:4},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Since",id:"since-20",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"emit(event, err)",id:"emitevent-err",level:4},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Since",id:"since-21",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"emit(event)",id:"emitevent-2",level:4},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Since",id:"since-22",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"emit(event, src)",id:"emitevent-src",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Since",id:"since-23",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"emit(event, src)",id:"emitevent-src-1",level:4},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Since",id:"since-24",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"emit(event, args)",id:"emitevent-args",level:4},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Since",id:"since-25",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"end()",id:"end",level:3},{value:"end(cb)",id:"endcb",level:4},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Since",id:"since-26",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"end(chunk, cb)",id:"endchunk-cb",level:4},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"end(chunk, encoding, cb)",id:"endchunk-encoding-cb",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-44",level:5},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-27",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-28",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Since",id:"since-29",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Since",id:"since-30",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"logv()?",id:"logv",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Since",id:"since-31",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"on()",id:"on",level:3},{value:"on(event, listener)",id:"onevent-listener",level:4},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Since",id:"since-32",level:5},{value:"Inherited from",id:"inherited-from-51",level:5},{value:"on(event, listener)",id:"onevent-listener-1",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-34",level:5},{value:"Since",id:"since-33",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"on(event, listener)",id:"onevent-listener-2",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Since",id:"since-34",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"on(event, listener)",id:"onevent-listener-3",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-36",level:5},{value:"Since",id:"since-35",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"on(event, listener)",id:"onevent-listener-4",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-36",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"on(event, listener)",id:"onevent-listener-5",level:4},{value:"Parameters",id:"parameters-34",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-37",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"on(event, listener)",id:"onevent-listener-6",level:4},{value:"Parameters",id:"parameters-35",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Since",id:"since-38",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"once()",id:"once",level:3},{value:"once(event, listener)",id:"onceevent-listener",level:4},{value:"Parameters",id:"parameters-36",level:5},{value:"Returns",id:"returns-40",level:5},{value:"Since",id:"since-39",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"once(event, listener)",id:"onceevent-listener-1",level:4},{value:"Parameters",id:"parameters-37",level:5},{value:"Returns",id:"returns-41",level:5},{value:"Since",id:"since-40",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"once(event, listener)",id:"onceevent-listener-2",level:4},{value:"Parameters",id:"parameters-38",level:5},{value:"Returns",id:"returns-42",level:5},{value:"Since",id:"since-41",level:5},{value:"Inherited from",id:"inherited-from-60",level:5},{value:"once(event, listener)",id:"onceevent-listener-3",level:4},{value:"Parameters",id:"parameters-39",level:5},{value:"Returns",id:"returns-43",level:5},{value:"Since",id:"since-42",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"once(event, listener)",id:"onceevent-listener-4",level:4},{value:"Parameters",id:"parameters-40",level:5},{value:"Returns",id:"returns-44",level:5},{value:"Since",id:"since-43",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"once(event, listener)",id:"onceevent-listener-5",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-45",level:5},{value:"Since",id:"since-44",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"once(event, listener)",id:"onceevent-listener-6",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-46",level:5},{value:"Since",id:"since-45",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"pipe()",id:"pipe",level:3},{value:"Type Parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-65",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-48",level:5},{value:"Since",id:"since-46",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Since",id:"since-47",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-50",level:5},{value:"Since",id:"since-48",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-47",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Since",id:"since-49",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Since",id:"since-50",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Since",id:"since-51",level:5},{value:"Inherited from",id:"inherited-from-71",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Since",id:"since-52",level:5},{value:"Inherited from",id:"inherited-from-72",level:5},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Since",id:"since-53",level:5},{value:"Inherited from",id:"inherited-from-73",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-56",level:5},{value:"Since",id:"since-54",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Since",id:"since-55",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Since",id:"since-56",level:5},{value:"Inherited from",id:"inherited-from-76",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Since",id:"since-57",level:5},{value:"Inherited from",id:"inherited-from-77",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-56",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Since",id:"since-58",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-57",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Since",id:"since-59",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Since",id:"since-60",level:4},{value:"Inherited from",id:"inherited-from-80",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Since",id:"since-61",level:4},{value:"Inherited from",id:"inherited-from-81",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"removeListener(event, listener)",id:"removelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-60",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Since",id:"since-62",level:5},{value:"Inherited from",id:"inherited-from-82",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-61",level:5},{value:"Returns",id:"returns-65",level:5},{value:"Since",id:"since-63",level:5},{value:"Inherited from",id:"inherited-from-83",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Since",id:"since-64",level:5},{value:"Inherited from",id:"inherited-from-84",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-67",level:5},{value:"Since",id:"since-65",level:5},{value:"Inherited from",id:"inherited-from-85",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-68",level:5},{value:"Since",id:"since-66",level:5},{value:"Inherited from",id:"inherited-from-86",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-69",level:5},{value:"Since",id:"since-67",level:5},{value:"Inherited from",id:"inherited-from-87",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-66",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Since",id:"since-68",level:5},{value:"Inherited from",id:"inherited-from-88",level:5},{value:"setDefaultEncoding()",id:"setdefaultencoding",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Since",id:"since-69",level:4},{value:"Inherited from",id:"inherited-from-89",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Since",id:"since-70",level:4},{value:"Inherited from",id:"inherited-from-90",level:4},{value:"uncork()",id:"uncork",level:3},{value:"Returns",id:"returns-73",level:4},{value:"Since",id:"since-71",level:4},{value:"Inherited from",id:"inherited-from-91",level:4},{value:"write()",id:"write",level:3},{value:"write(chunk, callback)",id:"writechunk-callback",level:4},{value:"Parameters",id:"parameters-69",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Since",id:"since-72",level:5},{value:"Inherited from",id:"inherited-from-92",level:5},{value:"write(chunk, encoding, callback)",id:"writechunk-encoding-callback",level:4},{value:"Parameters",id:"parameters-70",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-93",level:5},{value:"fromWeb()",id:"fromweb",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-76",level:4},{value:"Since",id:"since-73",level:4},{value:"Inherited from",id:"inherited-from-94",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-77",level:4},{value:"Since",id:"since-74",level:4},{value:"Inherited from",id:"inherited-from-95",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-78",level:4},{value:"Since",id:"since-75",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-96",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-79",level:4},{value:"Since",id:"since-76",level:4},{value:"Inherited from",id:"inherited-from-97",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-75",level:5},{value:"Returns",id:"returns-80",level:5},{value:"Since",id:"since-77",level:5},{value:"Inherited from",id:"inherited-from-98",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-76",level:5},{value:"Returns",id:"returns-81",level:5},{value:"Inherited from",id:"inherited-from-99",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-82",level:4},{value:"Since",id:"since-78",level:4},{value:"Inherited from",id:"inherited-from-100",level:4},{value:"toWeb()",id:"toweb",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-83",level:4},{value:"Since",id:"since-79",level:4},{value:"Inherited from",id:"inherited-from-101",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"class-nooptransport",children:"Class: NoOpTransport"}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"TransportStream"})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-nooptransport",children:"new NoOpTransport()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new NoOpTransport"}),"(",(0,i.jsx)(n.code,{children:"opts"}),"?): ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:(0,i.jsx)(n.code,{children:"NoOpTransport"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"opts?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:(0,i.jsx)(n.code,{children:"NoOpTransport"})})}),"\n",(0,i.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.constructor"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"closed",children:"closed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"closed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Is true after 'close' has been emitted."}),"\n",(0,i.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.closed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroyed",children:"destroyed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroyed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.destroy()"})," has been called."]}),"\n",(0,i.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroyed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errored",children:"errored"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"errored"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Returns error if the stream has been destroyed with an error."}),"\n",(0,i.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v18.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errored"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"format",children:"format?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"format"}),": ",(0,i.jsx)(n.code,{children:"Format"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.format"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handleexceptions",children:"handleExceptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleExceptions"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleExceptions"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handlerejections",children:"handleRejections?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"level",children:"level?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"level"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.level"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"silent"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.silent"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writable",children:"writable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if it is safe to call ",(0,i.jsx)(n.code,{children:"writable.write()"}),", which means\nthe stream has not been destroyed, errored or ended."]}),"\n",(0,i.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writable"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablecorked",children:"writableCorked"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableCorked"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Number of times ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," needs to be\ncalled in order to fully uncork the stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.2.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableCorked"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableended",children:"writableEnded"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableEnded"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.end()"})," has been called. This property\ndoes not indicate whether the data has been flushed, for this use ",(0,i.jsx)(n.code,{children:"writable.writableFinished"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.9.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableEnded"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablefinished",children:"writableFinished"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableFinished"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is set to ",(0,i.jsx)(n.code,{children:"true"})," immediately before the ",(0,i.jsx)(n.code,{children:"'finish'"})," event is emitted."]}),"\n",(0,i.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.6.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableFinished"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablehighwatermark",children:"writableHighWaterMark"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableHighWaterMark"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Return the value of ",(0,i.jsx)(n.code,{children:"highWaterMark"})," passed when creating this ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableHighWaterMark"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablelength",children:"writableLength"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This property contains the number of bytes (or objects) in the queue\nready to be written. The value provides introspection data regarding\nthe status of the ",(0,i.jsx)(n.code,{children:"highWaterMark"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableLength"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableneeddrain",children:"writableNeedDrain"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableNeedDrain"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if the stream's buffer has been full and stream will emit 'drain'."]}),"\n",(0,i.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableNeedDrain"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableobjectmode",children:"writableObjectMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableObjectMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Getter for the property ",(0,i.jsx)(n.code,{children:"objectMode"})," of a given ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableObjectMode"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,i.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejectionSymbol"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.defaultMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,i.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,i.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,i.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,i.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,i.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,i.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errorMonitor"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"_construct",children:"_construct()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_construct"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._construct"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_destroy",children:"_destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_final",children:"_final()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_final"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._final"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_write",children:"_write()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_writev",children:"_writev()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_writev"}),"(",(0,i.jsx)(n.code,{children:"chunks"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunks"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._writev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Event emitter\nThe defined events on documents including:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"close"}),"\n",(0,i.jsx)(n.li,{children:"drain"}),"\n",(0,i.jsx)(n.li,{children:"error"}),"\n",(0,i.jsx)(n.li,{children:"finish"}),"\n",(0,i.jsx)(n.li,{children:"pipe"}),"\n",(0,i.jsx)(n.li,{children:"unpipe"}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-1",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-11",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-2",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-12",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-3",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-13",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-4",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-14",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-5",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-15",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-6",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-12",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-16",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"close",children:"close()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"close"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.close"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cork",children:"cork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method forces all written data to be buffered in memory.\nThe buffered data will be flushed when either the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#uncork",children:"uncork"})," or ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#end",children:"end"})," methods are called."]}),"\n",(0,i.jsxs)(n.p,{children:["The primary intent of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," is to accommodate a situation in which\nseveral small chunks are written to the stream in rapid succession. Instead of\nimmediately forwarding them to the underlying destination, ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"buffers all the chunks until ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," is called, which will pass them\nall to ",(0,i.jsx)(n.code,{children:"writable._writev()"}),", if present. This prevents a head-of-line blocking\nsituation where data is being buffered while waiting for the first small chunk\nto be processed. However, use of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," without implementing",(0,i.jsx)(n.code,{children:"writable._writev()"})," may have an adverse effect on throughput."]}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.uncork()"}),", ",(0,i.jsx)(n.code,{children:"writable._writev()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.cork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Destroy the stream. Optionally emit an ",(0,i.jsx)(n.code,{children:"'error'"})," event, and emit a ",(0,i.jsx)(n.code,{children:"'close'"}),"event (unless ",(0,i.jsx)(n.code,{children:"emitClose"})," is set to ",(0,i.jsx)(n.code,{children:"false"}),"). After this call, the writable\nstream has ended and subsequent calls to ",(0,i.jsx)(n.code,{children:"write()"})," or ",(0,i.jsx)(n.code,{children:"end()"})," will result in\nan ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nThis is a destructive and immediate way to destroy a stream. Previous calls to",(0,i.jsx)(n.code,{children:"write()"})," may not have drained, and may trigger an ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nUse ",(0,i.jsx)(n.code,{children:"end()"})," instead of destroy if data should flush before close, or wait for\nthe ",(0,i.jsx)(n.code,{children:"'drain'"})," event before destroying the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["Once ",(0,i.jsx)(n.code,{children:"destroy()"})," has been called any further calls will be a no-op and no\nfurther errors except from ",(0,i.jsx)(n.code,{children:"_destroy()"})," may be emitted as ",(0,i.jsx)(n.code,{children:"'error'"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Implementors should not override this method,\nbut instead implement ",(0,i.jsx)(n.code,{children:"writable._destroy()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error?"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional, an error to emit with ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-18",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,i.jsx)(n.h4,{id:"emitevent",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-19",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-1",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-20",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-err",children:"emit(event, err)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"err"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"err"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-21",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-2",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-22",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-23",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src-1",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-24",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-args",children:"emit(event, args)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ...",(0,i.jsx)(n.code,{children:"args"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"args"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-25",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"end()"}),"\n",(0,i.jsx)(n.h4,{id:"endcb",children:"end(cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.code,{children:"writable.end()"})," method signals that no more data will be written\nto the ",(0,i.jsx)(n.code,{children:"Writable"}),". The optional ",(0,i.jsx)(n.code,{children:"chunk"})," and ",(0,i.jsx)(n.code,{children:"encoding"})," arguments allow one\nfinal additional chunk of data to be written immediately before closing the\nstream."]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#write",children:"write"})," method after calling ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#end",children:"end"})," will raise an error."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"// Write 'hello, ' and then end with 'world!'.\nconst fs = require('fs');\nconst file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// Writing more now is not allowed!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-26",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-cb",children:"end(chunk, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-encoding-cb",children:"end(chunk, encoding, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,i.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:["(",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-27",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.eventNames"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-28",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-29",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-30",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.log"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logv",children:"logv()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logv"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"next"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"next"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.logv"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"off"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-31",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.off"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-32",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-1",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-33",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-2",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-34",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-3",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-35",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-4",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-36",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-5",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-34",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-37",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-6",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-35",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-38",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-36",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-40",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-39",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-1",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-37",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-41",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-40",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-2",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-38",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-42",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-41",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-3",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-39",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-43",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-42",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-4",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-40",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-44",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-43",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-5",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-45",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-44",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-6",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-46",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-45",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pipe",children:"pipe()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pipe"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"destination"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"WritableStream"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"destination"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options.end?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.pipe"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-46",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-1",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-47",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-2",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-48",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-3",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-47",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-49",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-4",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-50",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-5",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-51",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-6",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-52",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-53",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-1",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-56",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-54",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-2",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-55",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-3",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-56",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-4",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-57",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-5",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-56",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-58",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-6",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-57",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-59",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"rawListeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,i.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-62",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-60",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.rawListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,i.jsx)(n.code,{children:"event"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event?"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-63",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-61",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeAllListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-60",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-62",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-1",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-61",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-63",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-2",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-64",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-84",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-3",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-67",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-65",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-85",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-4",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-68",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-66",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-86",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-5",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-69",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-67",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-87",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-6",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-66",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-68",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-88",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setdefaultencoding",children:"setDefaultEncoding()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setDefaultEncoding"}),"(",(0,i.jsx)(n.code,{children:"encoding"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.setDefaultEncoding()"})," method sets the default ",(0,i.jsx)(n.code,{children:"encoding"})," for a ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsx)(n.p,{children:"The new default encoding"}),"\n",(0,i.jsx)(n.h4,{id:"returns-71",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-69",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.15"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-89",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setDefaultEncoding"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["By default ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,i.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,i.jsx)(n.code,{children:"Infinity"})," (or ",(0,i.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-70",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-90",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"uncork",children:"uncork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"uncork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," method flushes all data buffered since ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#cork",children:"cork"})," was called."]}),"\n",(0,i.jsxs)(n.p,{children:["When using ",(0,i.jsx)(n.code,{children:"writable.cork()"})," and ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," to manage the buffering\nof writes to a stream, defer calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," using",(0,i.jsx)(n.code,{children:"process.nextTick()"}),". Doing so allows batching of all",(0,i.jsx)(n.code,{children:"writable.write()"})," calls that occur within a given Node.js event\nloop phase."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.write('data ');\nprocess.nextTick(() => stream.uncork());\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If the ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method is called multiple times on a stream, the\nsame number of calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," must be called to flush the buffered\ndata."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.cork();\nstream.write('data ');\nprocess.nextTick(() => {\n stream.uncork();\n // The data will not be flushed until uncork() is called a second time.\n stream.uncork();\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-71",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-91",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.uncork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"write",children:"write()"}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-callback",children:"write(chunk, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.write()"})," method writes some data to the stream, and calls the\nsupplied ",(0,i.jsx)(n.code,{children:"callback"})," once the data has been fully handled. If an error\noccurs, the ",(0,i.jsx)(n.code,{children:"callback"})," will be called with the error as its\nfirst argument. The ",(0,i.jsx)(n.code,{children:"callback"})," is called asynchronously and before ",(0,i.jsx)(n.code,{children:"'error'"})," is\nemitted."]}),"\n",(0,i.jsxs)(n.p,{children:["The return value is ",(0,i.jsx)(n.code,{children:"true"})," if the internal buffer is less than the",(0,i.jsx)(n.code,{children:"highWaterMark"})," configured when the stream was created after admitting ",(0,i.jsx)(n.code,{children:"chunk"}),".\nIf ",(0,i.jsx)(n.code,{children:"false"})," is returned, further attempts to write data to the stream should\nstop until the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted."]}),"\n",(0,i.jsxs)(n.p,{children:["While a stream is not draining, calls to ",(0,i.jsx)(n.code,{children:"write()"})," will buffer ",(0,i.jsx)(n.code,{children:"chunk"}),", and\nreturn false. Once all currently buffered chunks are drained (accepted for\ndelivery by the operating system), the ",(0,i.jsx)(n.code,{children:"'drain'"})," event will be emitted.\nOnce ",(0,i.jsx)(n.code,{children:"write()"})," returns false, do not write more chunks\nuntil the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted. While calling ",(0,i.jsx)(n.code,{children:"write()"})," on a stream that\nis not draining is allowed, Node.js will buffer all written chunks until\nmaximum memory usage occurs, at which point it will abort unconditionally.\nEven before it aborts, high memory usage will cause poor garbage collector\nperformance and high RSS (which is not typically released back to the system,\neven after the memory is no longer required). Since TCP sockets may never\ndrain if the remote peer does not read the data, writing a socket that is\nnot draining may lead to a remotely exploitable vulnerability."]}),"\n",(0,i.jsxs)(n.p,{children:["Writing data while the stream is not draining is particularly\nproblematic for a ",(0,i.jsx)(n.code,{children:"Transform"}),", because the ",(0,i.jsx)(n.code,{children:"Transform"})," streams are paused\nby default until they are piped or a ",(0,i.jsx)(n.code,{children:"'data'"})," or ",(0,i.jsx)(n.code,{children:"'readable'"})," event handler\nis added."]}),"\n",(0,i.jsxs)(n.p,{children:["If the data to be written can be generated or fetched on demand, it is\nrecommended to encapsulate the logic into a ",(0,i.jsx)(n.code,{children:"Readable"})," and use ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#pipe",children:"pipe"}),". However, if calling ",(0,i.jsx)(n.code,{children:"write()"})," is preferred, it is\npossible to respect backpressure and avoid memory issues using the ",(0,i.jsx)(n.code,{children:"'drain'"})," event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"function write(data, cb) {\n if (!stream.write(data)) {\n stream.once('drain', cb);\n } else {\n process.nextTick(cb);\n }\n}\n\n// Wait for cb to be called before doing any other write.\nwrite('hello', () => {\n console.log('Write completed, do more writes now.');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"Writable"})," stream in object mode will always ignore the ",(0,i.jsx)(n.code,{children:"encoding"})," argument."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-69",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional data to write. For streams not operating in object mode, ",(0,i.jsx)(n.code,{children:"chunk"})," must be a string, ",(0,i.jsx)(n.code,{children:"Buffer"})," or ",(0,i.jsx)(n.code,{children:"Uint8Array"}),". For object mode streams, ",(0,i.jsx)(n.code,{children:"chunk"})," may be any\nJavaScript value other than ",(0,i.jsx)(n.code,{children:"null"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.p,{children:"Callback for when this chunk of data is flushed."}),"\n",(0,i.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"false"})," if the stream wishes for the calling code to wait for the ",(0,i.jsx)(n.code,{children:"'drain'"})," event to be emitted before continuing to write additional data; otherwise ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"since-72",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-92",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-encoding-callback",children:"write(chunk, encoding, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-70",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-93",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fromweb",children:"fromWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"fromWeb"}),"(",(0,i.jsx)(n.code,{children:"writableStream"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a ",(0,i.jsx)(n.code,{children:"Writable"})," from a web ",(0,i.jsx)(n.code,{children:"WritableStream"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"writableStream"}),": ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Pick"}),"<",(0,i.jsx)(n.code,{children:"WritableOptions"}),", ",(0,i.jsx)(n.code,{children:'"signal"'})," | ",(0,i.jsx)(n.code,{children:'"decodeStrings"'})," | ",(0,i.jsx)(n.code,{children:'"highWaterMark"'})," | ",(0,i.jsx)(n.code,{children:'"objectMode"'}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-76",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Writable"})}),"\n",(0,i.jsx)(n.h4,{id:"since-73",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-94",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.fromWeb"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"name"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,i.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-77",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-74",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-95",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getEventListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount-1",children:(0,i.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,i.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,i.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The event name"}),"\n",(0,i.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-75",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,i.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-96",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns an ",(0,i.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,i.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,i.jsx)(n.code,{children:"emitter"})]}),"\n",(0,i.jsx)(n.h4,{id:"since-76",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-97",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Creates a ",(0,i.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,i.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,i.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,i.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,i.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The special handling of the ",(0,i.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,i.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,i.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,i.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-75",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-80",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"since-77",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-98",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-76",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-81",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-99",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"?, ...",(0,i.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n?"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,i.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-82",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-78",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-100",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"toweb",children:"toWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"toWeb"}),"(",(0,i.jsx)(n.code,{children:"streamWritable"}),"): ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a web ",(0,i.jsx)(n.code,{children:"WritableStream"})," from a ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"streamWritable"}),": ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-83",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"since-79",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-101",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.toWeb"})})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>d});var i=r(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1454731d.e1b179c1.js b/assets/js/1454731d.e1b179c1.js new file mode 100644 index 0000000000..60971d3e11 --- /dev/null +++ b/assets/js/1454731d.e1b179c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[314],{5773:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var i=r(4848),s=r(8453);const t={},l="Class: NoOpTransport",d={id:"reference/logging/custom_transport/classes/NoOpTransport",title:"Class: NoOpTransport",description:"Extends",source:"@site/docs/reference/logging/custom_transport/classes/NoOpTransport.md",sourceDirName:"reference/logging/custom_transport/classes",slug:"/reference/logging/custom_transport/classes/NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/classes/NoOpTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport"},next:{title:"logging/logging",permalink:"/docs/reference/logging/logging/"}},c={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new NoOpTransport()",id:"new-nooptransport",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"closed",id:"closed",level:3},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"destroyed",id:"destroyed",level:3},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"errored",id:"errored",level:3},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"format?",id:"format",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"handleExceptions?",id:"handleexceptions",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"handleRejections?",id:"handlerejections",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"level?",id:"level",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"silent?",id:"silent",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"writable",id:"writable",level:3},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"writableCorked",id:"writablecorked",level:3},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"writableEnded",id:"writableended",level:3},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"writableFinished",id:"writablefinished",level:3},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"writableHighWaterMark",id:"writablehighwatermark",level:3},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"writableLength",id:"writablelength",level:3},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"writableNeedDrain",id:"writableneeddrain",level:3},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"writableObjectMode",id:"writableobjectmode",level:3},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Methods",id:"methods",level:2},{value:"_construct()?",id:"_construct",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"_destroy()",id:"_destroy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"_final()",id:"_final",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"_write()",id:"_write",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"_writev()?",id:"_writev",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"addListener(event, listener)",id:"addlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Since",id:"since-11",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-8",level:5},{value:"Since",id:"since-12",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Since",id:"since-13",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Since",id:"since-14",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Since",id:"since-15",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Since",id:"since-16",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"close()?",id:"close",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"cork()",id:"cork",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-18",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"emit()",id:"emit",level:3},{value:"emit(event)",id:"emitevent",level:4},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Since",id:"since-19",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"emit(event)",id:"emitevent-1",level:4},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Since",id:"since-20",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"emit(event, err)",id:"emitevent-err",level:4},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Since",id:"since-21",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"emit(event)",id:"emitevent-2",level:4},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Since",id:"since-22",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"emit(event, src)",id:"emitevent-src",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Since",id:"since-23",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"emit(event, src)",id:"emitevent-src-1",level:4},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Since",id:"since-24",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"emit(event, args)",id:"emitevent-args",level:4},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Since",id:"since-25",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"end()",id:"end",level:3},{value:"end(cb)",id:"endcb",level:4},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Since",id:"since-26",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"end(chunk, cb)",id:"endchunk-cb",level:4},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"end(chunk, encoding, cb)",id:"endchunk-encoding-cb",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-44",level:5},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-27",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-28",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Since",id:"since-29",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Since",id:"since-30",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"logv()?",id:"logv",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Since",id:"since-31",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"on()",id:"on",level:3},{value:"on(event, listener)",id:"onevent-listener",level:4},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Since",id:"since-32",level:5},{value:"Inherited from",id:"inherited-from-51",level:5},{value:"on(event, listener)",id:"onevent-listener-1",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-34",level:5},{value:"Since",id:"since-33",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"on(event, listener)",id:"onevent-listener-2",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Since",id:"since-34",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"on(event, listener)",id:"onevent-listener-3",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-36",level:5},{value:"Since",id:"since-35",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"on(event, listener)",id:"onevent-listener-4",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-36",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"on(event, listener)",id:"onevent-listener-5",level:4},{value:"Parameters",id:"parameters-34",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-37",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"on(event, listener)",id:"onevent-listener-6",level:4},{value:"Parameters",id:"parameters-35",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Since",id:"since-38",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"once()",id:"once",level:3},{value:"once(event, listener)",id:"onceevent-listener",level:4},{value:"Parameters",id:"parameters-36",level:5},{value:"Returns",id:"returns-40",level:5},{value:"Since",id:"since-39",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"once(event, listener)",id:"onceevent-listener-1",level:4},{value:"Parameters",id:"parameters-37",level:5},{value:"Returns",id:"returns-41",level:5},{value:"Since",id:"since-40",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"once(event, listener)",id:"onceevent-listener-2",level:4},{value:"Parameters",id:"parameters-38",level:5},{value:"Returns",id:"returns-42",level:5},{value:"Since",id:"since-41",level:5},{value:"Inherited from",id:"inherited-from-60",level:5},{value:"once(event, listener)",id:"onceevent-listener-3",level:4},{value:"Parameters",id:"parameters-39",level:5},{value:"Returns",id:"returns-43",level:5},{value:"Since",id:"since-42",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"once(event, listener)",id:"onceevent-listener-4",level:4},{value:"Parameters",id:"parameters-40",level:5},{value:"Returns",id:"returns-44",level:5},{value:"Since",id:"since-43",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"once(event, listener)",id:"onceevent-listener-5",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-45",level:5},{value:"Since",id:"since-44",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"once(event, listener)",id:"onceevent-listener-6",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-46",level:5},{value:"Since",id:"since-45",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"pipe()",id:"pipe",level:3},{value:"Type Parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-65",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-48",level:5},{value:"Since",id:"since-46",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Since",id:"since-47",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-50",level:5},{value:"Since",id:"since-48",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-47",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Since",id:"since-49",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Since",id:"since-50",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Since",id:"since-51",level:5},{value:"Inherited from",id:"inherited-from-71",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Since",id:"since-52",level:5},{value:"Inherited from",id:"inherited-from-72",level:5},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Since",id:"since-53",level:5},{value:"Inherited from",id:"inherited-from-73",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-56",level:5},{value:"Since",id:"since-54",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Since",id:"since-55",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Since",id:"since-56",level:5},{value:"Inherited from",id:"inherited-from-76",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Since",id:"since-57",level:5},{value:"Inherited from",id:"inherited-from-77",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-56",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Since",id:"since-58",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-57",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Since",id:"since-59",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Since",id:"since-60",level:4},{value:"Inherited from",id:"inherited-from-80",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Since",id:"since-61",level:4},{value:"Inherited from",id:"inherited-from-81",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"removeListener(event, listener)",id:"removelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-60",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Since",id:"since-62",level:5},{value:"Inherited from",id:"inherited-from-82",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-61",level:5},{value:"Returns",id:"returns-65",level:5},{value:"Since",id:"since-63",level:5},{value:"Inherited from",id:"inherited-from-83",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Since",id:"since-64",level:5},{value:"Inherited from",id:"inherited-from-84",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-67",level:5},{value:"Since",id:"since-65",level:5},{value:"Inherited from",id:"inherited-from-85",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-68",level:5},{value:"Since",id:"since-66",level:5},{value:"Inherited from",id:"inherited-from-86",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-69",level:5},{value:"Since",id:"since-67",level:5},{value:"Inherited from",id:"inherited-from-87",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-66",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Since",id:"since-68",level:5},{value:"Inherited from",id:"inherited-from-88",level:5},{value:"setDefaultEncoding()",id:"setdefaultencoding",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Since",id:"since-69",level:4},{value:"Inherited from",id:"inherited-from-89",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Since",id:"since-70",level:4},{value:"Inherited from",id:"inherited-from-90",level:4},{value:"uncork()",id:"uncork",level:3},{value:"Returns",id:"returns-73",level:4},{value:"Since",id:"since-71",level:4},{value:"Inherited from",id:"inherited-from-91",level:4},{value:"write()",id:"write",level:3},{value:"write(chunk, callback)",id:"writechunk-callback",level:4},{value:"Parameters",id:"parameters-69",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Since",id:"since-72",level:5},{value:"Inherited from",id:"inherited-from-92",level:5},{value:"write(chunk, encoding, callback)",id:"writechunk-encoding-callback",level:4},{value:"Parameters",id:"parameters-70",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-93",level:5},{value:"fromWeb()",id:"fromweb",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-76",level:4},{value:"Since",id:"since-73",level:4},{value:"Inherited from",id:"inherited-from-94",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-77",level:4},{value:"Since",id:"since-74",level:4},{value:"Inherited from",id:"inherited-from-95",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-78",level:4},{value:"Since",id:"since-75",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-96",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-79",level:4},{value:"Since",id:"since-76",level:4},{value:"Inherited from",id:"inherited-from-97",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-75",level:5},{value:"Returns",id:"returns-80",level:5},{value:"Since",id:"since-77",level:5},{value:"Inherited from",id:"inherited-from-98",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-76",level:5},{value:"Returns",id:"returns-81",level:5},{value:"Inherited from",id:"inherited-from-99",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-82",level:4},{value:"Since",id:"since-78",level:4},{value:"Inherited from",id:"inherited-from-100",level:4},{value:"toWeb()",id:"toweb",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-83",level:4},{value:"Since",id:"since-79",level:4},{value:"Inherited from",id:"inherited-from-101",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-nooptransport",children:"Class: NoOpTransport"})}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"TransportStream"})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-nooptransport",children:"new NoOpTransport()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new NoOpTransport"}),"(",(0,i.jsx)(n.code,{children:"opts"}),"?): ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:(0,i.jsx)(n.code,{children:"NoOpTransport"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"opts?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:(0,i.jsx)(n.code,{children:"NoOpTransport"})})}),"\n",(0,i.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.constructor"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"closed",children:"closed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"closed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Is true after 'close' has been emitted."}),"\n",(0,i.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.closed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroyed",children:"destroyed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroyed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.destroy()"})," has been called."]}),"\n",(0,i.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroyed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errored",children:"errored"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"errored"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Returns error if the stream has been destroyed with an error."}),"\n",(0,i.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v18.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errored"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"format",children:"format?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"format"}),": ",(0,i.jsx)(n.code,{children:"Format"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.format"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handleexceptions",children:"handleExceptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleExceptions"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleExceptions"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handlerejections",children:"handleRejections?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"level",children:"level?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"level"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.level"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"silent"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.silent"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writable",children:"writable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if it is safe to call ",(0,i.jsx)(n.code,{children:"writable.write()"}),", which means\nthe stream has not been destroyed, errored or ended."]}),"\n",(0,i.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writable"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablecorked",children:"writableCorked"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableCorked"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Number of times ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," needs to be\ncalled in order to fully uncork the stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.2.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableCorked"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableended",children:"writableEnded"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableEnded"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.end()"})," has been called. This property\ndoes not indicate whether the data has been flushed, for this use ",(0,i.jsx)(n.code,{children:"writable.writableFinished"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.9.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableEnded"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablefinished",children:"writableFinished"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableFinished"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is set to ",(0,i.jsx)(n.code,{children:"true"})," immediately before the ",(0,i.jsx)(n.code,{children:"'finish'"})," event is emitted."]}),"\n",(0,i.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.6.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableFinished"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablehighwatermark",children:"writableHighWaterMark"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableHighWaterMark"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Return the value of ",(0,i.jsx)(n.code,{children:"highWaterMark"})," passed when creating this ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableHighWaterMark"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablelength",children:"writableLength"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This property contains the number of bytes (or objects) in the queue\nready to be written. The value provides introspection data regarding\nthe status of the ",(0,i.jsx)(n.code,{children:"highWaterMark"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableLength"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableneeddrain",children:"writableNeedDrain"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableNeedDrain"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if the stream's buffer has been full and stream will emit 'drain'."]}),"\n",(0,i.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableNeedDrain"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableobjectmode",children:"writableObjectMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableObjectMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Getter for the property ",(0,i.jsx)(n.code,{children:"objectMode"})," of a given ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableObjectMode"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,i.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejectionSymbol"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.defaultMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,i.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,i.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,i.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,i.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,i.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,i.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errorMonitor"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"_construct",children:"_construct()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_construct"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._construct"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_destroy",children:"_destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_final",children:"_final()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_final"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._final"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_write",children:"_write()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_writev",children:"_writev()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_writev"}),"(",(0,i.jsx)(n.code,{children:"chunks"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunks"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._writev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Event emitter\nThe defined events on documents including:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"close"}),"\n",(0,i.jsx)(n.li,{children:"drain"}),"\n",(0,i.jsx)(n.li,{children:"error"}),"\n",(0,i.jsx)(n.li,{children:"finish"}),"\n",(0,i.jsx)(n.li,{children:"pipe"}),"\n",(0,i.jsx)(n.li,{children:"unpipe"}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-1",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-11",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-2",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-12",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-3",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-13",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-4",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-14",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-5",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-15",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-6",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-12",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-16",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"close",children:"close()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"close"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.close"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cork",children:"cork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method forces all written data to be buffered in memory.\nThe buffered data will be flushed when either the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#uncork",children:"uncork"})," or ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#end",children:"end"})," methods are called."]}),"\n",(0,i.jsxs)(n.p,{children:["The primary intent of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," is to accommodate a situation in which\nseveral small chunks are written to the stream in rapid succession. Instead of\nimmediately forwarding them to the underlying destination, ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"buffers all the chunks until ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," is called, which will pass them\nall to ",(0,i.jsx)(n.code,{children:"writable._writev()"}),", if present. This prevents a head-of-line blocking\nsituation where data is being buffered while waiting for the first small chunk\nto be processed. However, use of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," without implementing",(0,i.jsx)(n.code,{children:"writable._writev()"})," may have an adverse effect on throughput."]}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.uncork()"}),", ",(0,i.jsx)(n.code,{children:"writable._writev()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.cork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Destroy the stream. Optionally emit an ",(0,i.jsx)(n.code,{children:"'error'"})," event, and emit a ",(0,i.jsx)(n.code,{children:"'close'"}),"event (unless ",(0,i.jsx)(n.code,{children:"emitClose"})," is set to ",(0,i.jsx)(n.code,{children:"false"}),"). After this call, the writable\nstream has ended and subsequent calls to ",(0,i.jsx)(n.code,{children:"write()"})," or ",(0,i.jsx)(n.code,{children:"end()"})," will result in\nan ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nThis is a destructive and immediate way to destroy a stream. Previous calls to",(0,i.jsx)(n.code,{children:"write()"})," may not have drained, and may trigger an ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nUse ",(0,i.jsx)(n.code,{children:"end()"})," instead of destroy if data should flush before close, or wait for\nthe ",(0,i.jsx)(n.code,{children:"'drain'"})," event before destroying the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["Once ",(0,i.jsx)(n.code,{children:"destroy()"})," has been called any further calls will be a no-op and no\nfurther errors except from ",(0,i.jsx)(n.code,{children:"_destroy()"})," may be emitted as ",(0,i.jsx)(n.code,{children:"'error'"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Implementors should not override this method,\nbut instead implement ",(0,i.jsx)(n.code,{children:"writable._destroy()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error?"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional, an error to emit with ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-18",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,i.jsx)(n.h4,{id:"emitevent",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-19",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-1",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-20",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-err",children:"emit(event, err)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"err"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"err"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-21",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-2",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-22",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-23",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src-1",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-24",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-args",children:"emit(event, args)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ...",(0,i.jsx)(n.code,{children:"args"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"args"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-25",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"end()"}),"\n",(0,i.jsx)(n.h4,{id:"endcb",children:"end(cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.code,{children:"writable.end()"})," method signals that no more data will be written\nto the ",(0,i.jsx)(n.code,{children:"Writable"}),". The optional ",(0,i.jsx)(n.code,{children:"chunk"})," and ",(0,i.jsx)(n.code,{children:"encoding"})," arguments allow one\nfinal additional chunk of data to be written immediately before closing the\nstream."]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#write",children:"write"})," method after calling ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#end",children:"end"})," will raise an error."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"// Write 'hello, ' and then end with 'world!'.\nconst fs = require('fs');\nconst file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// Writing more now is not allowed!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-26",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-cb",children:"end(chunk, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-encoding-cb",children:"end(chunk, encoding, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,i.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:["(",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-27",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.eventNames"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-28",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-29",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-30",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.log"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logv",children:"logv()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logv"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"next"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"next"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.logv"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"off"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-31",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.off"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-32",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-1",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-33",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-2",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-34",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-3",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-35",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-4",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-36",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-5",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-34",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-37",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-6",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-35",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-38",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-36",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-40",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-39",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-1",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-37",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-41",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-40",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-2",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-38",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-42",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-41",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-3",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-39",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-43",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-42",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-4",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-40",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-44",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-43",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-5",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-45",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-44",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-6",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-46",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-45",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pipe",children:"pipe()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pipe"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"destination"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"WritableStream"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"destination"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options.end?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.pipe"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-46",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-1",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-47",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-2",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-48",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-3",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-47",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-49",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-4",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-50",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-5",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-51",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-6",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-52",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-53",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-1",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-56",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-54",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-2",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-55",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-3",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-56",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-4",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-57",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-5",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-56",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-58",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-6",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-57",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-59",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"rawListeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,i.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-62",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-60",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.rawListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,i.jsx)(n.code,{children:"event"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event?"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-63",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-61",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeAllListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-60",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-62",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-1",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-61",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-63",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-2",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-64",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-84",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-3",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-67",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-65",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-85",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-4",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-68",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-66",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-86",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-5",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-69",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-67",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-87",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-6",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-66",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-68",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-88",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setdefaultencoding",children:"setDefaultEncoding()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setDefaultEncoding"}),"(",(0,i.jsx)(n.code,{children:"encoding"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.setDefaultEncoding()"})," method sets the default ",(0,i.jsx)(n.code,{children:"encoding"})," for a ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsx)(n.p,{children:"The new default encoding"}),"\n",(0,i.jsx)(n.h4,{id:"returns-71",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-69",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.15"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-89",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setDefaultEncoding"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["By default ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,i.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,i.jsx)(n.code,{children:"Infinity"})," (or ",(0,i.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-70",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-90",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"uncork",children:"uncork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"uncork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," method flushes all data buffered since ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#cork",children:"cork"})," was called."]}),"\n",(0,i.jsxs)(n.p,{children:["When using ",(0,i.jsx)(n.code,{children:"writable.cork()"})," and ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," to manage the buffering\nof writes to a stream, defer calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," using",(0,i.jsx)(n.code,{children:"process.nextTick()"}),". Doing so allows batching of all",(0,i.jsx)(n.code,{children:"writable.write()"})," calls that occur within a given Node.js event\nloop phase."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.write('data ');\nprocess.nextTick(() => stream.uncork());\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If the ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method is called multiple times on a stream, the\nsame number of calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," must be called to flush the buffered\ndata."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.cork();\nstream.write('data ');\nprocess.nextTick(() => {\n stream.uncork();\n // The data will not be flushed until uncork() is called a second time.\n stream.uncork();\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-71",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-91",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.uncork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"write",children:"write()"}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-callback",children:"write(chunk, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.write()"})," method writes some data to the stream, and calls the\nsupplied ",(0,i.jsx)(n.code,{children:"callback"})," once the data has been fully handled. If an error\noccurs, the ",(0,i.jsx)(n.code,{children:"callback"})," will be called with the error as its\nfirst argument. The ",(0,i.jsx)(n.code,{children:"callback"})," is called asynchronously and before ",(0,i.jsx)(n.code,{children:"'error'"})," is\nemitted."]}),"\n",(0,i.jsxs)(n.p,{children:["The return value is ",(0,i.jsx)(n.code,{children:"true"})," if the internal buffer is less than the",(0,i.jsx)(n.code,{children:"highWaterMark"})," configured when the stream was created after admitting ",(0,i.jsx)(n.code,{children:"chunk"}),".\nIf ",(0,i.jsx)(n.code,{children:"false"})," is returned, further attempts to write data to the stream should\nstop until the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted."]}),"\n",(0,i.jsxs)(n.p,{children:["While a stream is not draining, calls to ",(0,i.jsx)(n.code,{children:"write()"})," will buffer ",(0,i.jsx)(n.code,{children:"chunk"}),", and\nreturn false. Once all currently buffered chunks are drained (accepted for\ndelivery by the operating system), the ",(0,i.jsx)(n.code,{children:"'drain'"})," event will be emitted.\nOnce ",(0,i.jsx)(n.code,{children:"write()"})," returns false, do not write more chunks\nuntil the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted. While calling ",(0,i.jsx)(n.code,{children:"write()"})," on a stream that\nis not draining is allowed, Node.js will buffer all written chunks until\nmaximum memory usage occurs, at which point it will abort unconditionally.\nEven before it aborts, high memory usage will cause poor garbage collector\nperformance and high RSS (which is not typically released back to the system,\neven after the memory is no longer required). Since TCP sockets may never\ndrain if the remote peer does not read the data, writing a socket that is\nnot draining may lead to a remotely exploitable vulnerability."]}),"\n",(0,i.jsxs)(n.p,{children:["Writing data while the stream is not draining is particularly\nproblematic for a ",(0,i.jsx)(n.code,{children:"Transform"}),", because the ",(0,i.jsx)(n.code,{children:"Transform"})," streams are paused\nby default until they are piped or a ",(0,i.jsx)(n.code,{children:"'data'"})," or ",(0,i.jsx)(n.code,{children:"'readable'"})," event handler\nis added."]}),"\n",(0,i.jsxs)(n.p,{children:["If the data to be written can be generated or fetched on demand, it is\nrecommended to encapsulate the logic into a ",(0,i.jsx)(n.code,{children:"Readable"})," and use ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport#pipe",children:"pipe"}),". However, if calling ",(0,i.jsx)(n.code,{children:"write()"})," is preferred, it is\npossible to respect backpressure and avoid memory issues using the ",(0,i.jsx)(n.code,{children:"'drain'"})," event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"function write(data, cb) {\n if (!stream.write(data)) {\n stream.once('drain', cb);\n } else {\n process.nextTick(cb);\n }\n}\n\n// Wait for cb to be called before doing any other write.\nwrite('hello', () => {\n console.log('Write completed, do more writes now.');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"Writable"})," stream in object mode will always ignore the ",(0,i.jsx)(n.code,{children:"encoding"})," argument."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-69",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional data to write. For streams not operating in object mode, ",(0,i.jsx)(n.code,{children:"chunk"})," must be a string, ",(0,i.jsx)(n.code,{children:"Buffer"})," or ",(0,i.jsx)(n.code,{children:"Uint8Array"}),". For object mode streams, ",(0,i.jsx)(n.code,{children:"chunk"})," may be any\nJavaScript value other than ",(0,i.jsx)(n.code,{children:"null"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.p,{children:"Callback for when this chunk of data is flushed."}),"\n",(0,i.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"false"})," if the stream wishes for the calling code to wait for the ",(0,i.jsx)(n.code,{children:"'drain'"})," event to be emitted before continuing to write additional data; otherwise ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"since-72",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-92",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-encoding-callback",children:"write(chunk, encoding, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-70",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-93",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fromweb",children:"fromWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"fromWeb"}),"(",(0,i.jsx)(n.code,{children:"writableStream"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a ",(0,i.jsx)(n.code,{children:"Writable"})," from a web ",(0,i.jsx)(n.code,{children:"WritableStream"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"writableStream"}),": ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Pick"}),"<",(0,i.jsx)(n.code,{children:"WritableOptions"}),", ",(0,i.jsx)(n.code,{children:'"signal"'})," | ",(0,i.jsx)(n.code,{children:'"decodeStrings"'})," | ",(0,i.jsx)(n.code,{children:'"highWaterMark"'})," | ",(0,i.jsx)(n.code,{children:'"objectMode"'}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-76",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Writable"})}),"\n",(0,i.jsx)(n.h4,{id:"since-73",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-94",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.fromWeb"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"name"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,i.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-77",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-74",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-95",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getEventListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount-1",children:(0,i.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,i.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,i.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The event name"}),"\n",(0,i.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-75",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,i.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-96",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns an ",(0,i.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,i.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,i.jsx)(n.code,{children:"emitter"})]}),"\n",(0,i.jsx)(n.h4,{id:"since-76",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-97",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Creates a ",(0,i.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,i.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,i.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,i.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,i.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The special handling of the ",(0,i.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,i.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,i.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,i.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-75",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-80",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"since-77",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-98",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-76",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-81",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-99",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"?, ...",(0,i.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n?"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,i.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-82",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-78",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-100",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"toweb",children:"toWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"toWeb"}),"(",(0,i.jsx)(n.code,{children:"streamWritable"}),"): ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a web ",(0,i.jsx)(n.code,{children:"WritableStream"})," from a ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"streamWritable"}),": ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-83",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"since-79",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-101",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.toWeb"})})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>d});var i=r(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/146bd2aa.5a611dc1.js b/assets/js/146bd2aa.5a611dc1.js deleted file mode 100644 index 2bece0db20..0000000000 --- a/assets/js/146bd2aa.5a611dc1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9160],{5865:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=r(4848),i=r(8453);const o={},c="Enumeration: LicenseType",t={id:"reference/api/model/config/enumerations/LicenseType",title:"Enumeration: LicenseType",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/LicenseType.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/LicenseType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: DIRECTORY\\_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY"},next:{title:"Enumeration: NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"B2B_RESTRICTED_VOLUME_LICENSE",id:"b2b_restricted_volume_license",level:3},{value:"CUSTOM",id:"custom",level:3},{value:"IMAGE_STORY",id:"image_story",level:3},{value:"INSIDER",id:"insider",level:3},{value:"NONE",id:"none",level:3},{value:"PREMIUM",id:"premium",level:3},{value:"TEXT_STORY",id:"text_story",level:3},{value:"VIDEO_STORY",id:"video_story",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"enumeration-licensetype",children:"Enumeration: LicenseType"}),"\n",(0,s.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,s.jsx)(n.h3,{id:"b2b_restricted_volume_license",children:"B2B_RESTRICTED_VOLUME_LICENSE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"B2B_RESTRICTED_VOLUME_LICENSE"}),": ",(0,s.jsx)(n.code,{children:'"B2B_RESTRICTED_VOLUME_LICENSE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"custom",children:"CUSTOM"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"CUSTOM"}),": ",(0,s.jsx)(n.code,{children:'"CUSTOM"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image_story",children:"IMAGE_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IMAGE_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Image Story License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insider",children:"INSIDER"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"INSIDER"}),": ",(0,s.jsx)(n.code,{children:'"Insiders Program"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"none",children:"NONE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NONE"}),": ",(0,s.jsx)(n.code,{children:'"NONE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"premium",children:"PREMIUM"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"PREMIUM"}),": ",(0,s.jsx)(n.code,{children:'"Premium License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"text_story",children:"TEXT_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"TEXT_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Text Story License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"video_story",children:"VIDEO_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VIDEO_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Video Story License Key"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>t});var s=r(6540);const i={},o=s.createContext(i);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/146bd2aa.7bb58db7.js b/assets/js/146bd2aa.7bb58db7.js new file mode 100644 index 0000000000..bb4d8bd071 --- /dev/null +++ b/assets/js/146bd2aa.7bb58db7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9160],{5865:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=r(4848),i=r(8453);const o={},c="Enumeration: LicenseType",t={id:"reference/api/model/config/enumerations/LicenseType",title:"Enumeration: LicenseType",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/LicenseType.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/LicenseType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: DIRECTORY\\_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY"},next:{title:"Enumeration: NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"B2B_RESTRICTED_VOLUME_LICENSE",id:"b2b_restricted_volume_license",level:3},{value:"CUSTOM",id:"custom",level:3},{value:"IMAGE_STORY",id:"image_story",level:3},{value:"INSIDER",id:"insider",level:3},{value:"NONE",id:"none",level:3},{value:"PREMIUM",id:"premium",level:3},{value:"TEXT_STORY",id:"text_story",level:3},{value:"VIDEO_STORY",id:"video_story",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"enumeration-licensetype",children:"Enumeration: LicenseType"})}),"\n",(0,s.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,s.jsx)(n.h3,{id:"b2b_restricted_volume_license",children:"B2B_RESTRICTED_VOLUME_LICENSE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"B2B_RESTRICTED_VOLUME_LICENSE"}),": ",(0,s.jsx)(n.code,{children:'"B2B_RESTRICTED_VOLUME_LICENSE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"custom",children:"CUSTOM"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"CUSTOM"}),": ",(0,s.jsx)(n.code,{children:'"CUSTOM"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image_story",children:"IMAGE_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IMAGE_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Image Story License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insider",children:"INSIDER"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"INSIDER"}),": ",(0,s.jsx)(n.code,{children:'"Insiders Program"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"none",children:"NONE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NONE"}),": ",(0,s.jsx)(n.code,{children:'"NONE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"premium",children:"PREMIUM"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"PREMIUM"}),": ",(0,s.jsx)(n.code,{children:'"Premium License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"text_story",children:"TEXT_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"TEXT_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Text Story License Key"'})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"video_story",children:"VIDEO_STORY"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VIDEO_STORY"}),": ",(0,s.jsx)(n.code,{children:'"Video Story License Key"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>t});var s=r(6540);const i={},o=s.createContext(i);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/14eb3368.288f5ab7.js b/assets/js/14eb3368.de016bf0.js similarity index 97% rename from assets/js/14eb3368.288f5ab7.js rename to assets/js/14eb3368.de016bf0.js index 29cc97bf82..0a4315bd64 100644 --- a/assets/js/14eb3368.288f5ab7.js +++ b/assets/js/14eb3368.de016bf0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6969],{1243:(e,t,n)=>{n.d(t,{A:()=>g});n(6540);var s=n(4164),r=n(7559),i=n(4142),a=n(9169),l=n(8774),o=n(1312),c=n(6025),d=n(4848);function u(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,d.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}const m={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function h(){const e=(0,c.Ay)("/");return(0,d.jsx)("li",{className:"breadcrumbs__item",children:(0,d.jsx)(l.A,{"aria-label":(0,o.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,d.jsx)(u,{className:m.breadcrumbHomeIcon})})})}const b={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function x(e){let{children:t,href:n,isLast:s}=e;const r="breadcrumbs__link";return s?(0,d.jsx)("span",{className:r,itemProp:"name",children:t}):n?(0,d.jsx)(l.A,{className:r,href:n,itemProp:"item",children:(0,d.jsx)("span",{itemProp:"name",children:t})}):(0,d.jsx)("span",{className:r,children:t})}function p(e){let{children:t,active:n,index:r,addMicrodata:i}=e;return(0,d.jsxs)("li",{...i&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},className:(0,s.A)("breadcrumbs__item",{"breadcrumbs__item--active":n}),children:[t,(0,d.jsx)("meta",{itemProp:"position",content:String(r+1)})]})}function g(){const e=(0,i.OF)(),t=(0,a.Dt)();return e?(0,d.jsx)("nav",{className:(0,s.A)(r.G.docs.docBreadcrumbs,b.breadcrumbsContainer),"aria-label":(0,o.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,d.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[t&&(0,d.jsx)(h,{}),e.map(((t,n)=>{const s=n===e.length-1,r="category"===t.type&&t.linkUnlisted?void 0:t.href;return(0,d.jsx)(p,{active:s,index:n,addMicrodata:!!r,children:(0,d.jsx)(x,{href:r,isLast:s,children:t.label})},n)}))]})}):null}},4136:(e,t,n)=>{n.r(t),n.d(t,{default:()=>w});n(6540);var s=n(5500),r=n(4142),i=n(6025),a=n(4164),l=n(8774),o=n(5846),c=n(6654),d=n(1312),u=n(1107);const m={cardContainer:"cardContainer_fWXF",cardTitle:"cardTitle_rnsV",cardDescription:"cardDescription_PWke"};var h=n(4848);function b(e){let{href:t,children:n}=e;return(0,h.jsx)(l.A,{href:t,className:(0,a.A)("card padding--lg",m.cardContainer),children:n})}function x(e){let{href:t,icon:n,title:s,description:r}=e;return(0,h.jsxs)(b,{href:t,children:[(0,h.jsxs)(u.A,{as:"h2",className:(0,a.A)("text--truncate",m.cardTitle),title:s,children:[n," ",s]}),r&&(0,h.jsx)("p",{className:(0,a.A)("text--truncate",m.cardDescription),title:r,children:r})]})}function p(e){let{item:t}=e;const n=(0,r.Nr)(t),s=function(){const{selectMessage:e}=(0,o.W)();return t=>e(t,(0,d.T)({message:"1 item|{count} items",id:"theme.docs.DocCard.categoryDescription.plurals",description:"The default description for a category card in the generated index about how many items this category includes"},{count:t}))}();return n?(0,h.jsx)(x,{href:n,icon:"\ud83d\uddc3\ufe0f",title:t.label,description:t.description??s(t.items.length)}):null}function g(e){let{item:t}=e;const n=(0,c.A)(t.href)?"\ud83d\udcc4\ufe0f":"\ud83d\udd17",s=(0,r.cC)(t.docId??void 0);return(0,h.jsx)(x,{href:t.href,icon:n,title:t.label,description:t.description??s?.description})}function v(e){let{item:t}=e;switch(t.type){case"link":return(0,h.jsx)(g,{item:t});case"category":return(0,h.jsx)(p,{item:t});default:throw new Error(`unknown item type ${JSON.stringify(t)}`)}}function f(e){let{className:t}=e;const n=(0,r.$S)();return(0,h.jsx)(j,{items:n.items,className:t})}function j(e){const{items:t,className:n}=e;if(!t)return(0,h.jsx)(f,{...e});const s=(0,r.d1)(t);return(0,h.jsx)("section",{className:(0,a.A)("row",n),children:s.map(((e,t)=>(0,h.jsx)("article",{className:"col col--6 margin-bottom--lg",children:(0,h.jsx)(v,{item:e})},t)))})}var A=n(7719),N=n(1878),T=n(4267),L=n(1243);const _={generatedIndexPage:"generatedIndexPage_vN6x",list:"list_eTzJ",title:"title_kItE"};function k(e){let{categoryGeneratedIndex:t}=e;return(0,h.jsx)(s.be,{title:t.title,description:t.description,keywords:t.keywords,image:(0,i.Ay)(t.image)})}function y(e){let{categoryGeneratedIndex:t}=e;const n=(0,r.$S)();return(0,h.jsxs)("div",{className:_.generatedIndexPage,children:[(0,h.jsx)(N.A,{}),(0,h.jsx)(L.A,{}),(0,h.jsx)(T.A,{}),(0,h.jsxs)("header",{children:[(0,h.jsx)(u.A,{as:"h1",className:_.title,children:t.title}),t.description&&(0,h.jsx)("p",{children:t.description})]}),(0,h.jsx)("article",{className:"margin-top--lg",children:(0,h.jsx)(j,{items:n.items,className:_.list})}),(0,h.jsx)("footer",{className:"margin-top--lg",children:(0,h.jsx)(A.A,{previous:t.navigation.previous,next:t.navigation.next})})]})}function w(e){return(0,h.jsxs)(h.Fragment,{children:[(0,h.jsx)(k,{...e}),(0,h.jsx)(y,{...e})]})}},7719:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(1312),r=n(9022),i=n(4848);function a(e){const{previous:t,next:n}=e;return(0,i.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,s.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[t&&(0,i.jsx)(r.A,{...t,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),n&&(0,i.jsx)(r.A,{...n,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},4267:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var s=n(4164),r=n(1312),i=n(7559),a=n(2252),l=n(4848);function o(e){let{className:t}=e;const n=(0,a.r)();return n.badge?(0,l.jsx)("span",{className:(0,s.A)(t,i.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,l.jsx)(r.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label},children:"Version: {versionLabel}"})}):null}},1878:(e,t,n)=>{n.d(t,{A:()=>p});n(6540);var s=n(4164),r=n(4586),i=n(8774),a=n(1312),l=n(4070),o=n(7559),c=n(5597),d=n(2252),u=n(4848);const m={unreleased:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){const t=m[e.versionMetadata.banner];return(0,u.jsx)(t,{...e})}function b(e){let{versionLabel:t,to:n,onClick:s}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:(0,u.jsx)("b",{children:(0,u.jsx)(i.A,{to:n,onClick:s,children:(0,u.jsx)(a.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function x(e){let{className:t,versionMetadata:n}=e;const{siteConfig:{title:i}}=(0,r.A)(),{pluginId:a}=(0,l.vT)({failfast:!0}),{savePreferredVersionName:d}=(0,c.g1)(a),{latestDocSuggestion:m,latestVersionSuggestion:x}=(0,l.HW)(a),p=m??(g=x).docs.find((e=>e.id===g.mainDocId));var g;return(0,u.jsxs)("div",{className:(0,s.A)(t,o.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,u.jsx)("div",{children:(0,u.jsx)(h,{siteTitle:i,versionMetadata:n})}),(0,u.jsx)("div",{className:"margin-top--md",children:(0,u.jsx)(b,{versionLabel:x.label,to:p.path,onClick:()=>d(x.name)})})]})}function p(e){let{className:t}=e;const n=(0,d.r)();return n.banner?(0,u.jsx)(x,{className:t,versionMetadata:n}):null}},9022:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(4164),r=n(8774),i=n(4848);function a(e){const{permalink:t,title:n,subLabel:a,isNext:l}=e;return(0,i.jsxs)(r.A,{className:(0,s.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[a&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:a}),(0,i.jsx)("div",{className:"pagination-nav__label",children:n})]})}},5846:(e,t,n)=>{n.d(t,{W:()=>c});var s=n(6540),r=n(4586);const i=["zero","one","two","few","many","other"];function a(e){return i.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:a(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,r.A)();return(0,s.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:a(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function c(){const e=o();return{selectMessage:(t,n)=>function(e,t,n){const s=e.split("|");if(1===s.length)return s[0];s.length>n.pluralForms.length&&console.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${s.length}: ${e}`);const r=n.select(t),i=n.pluralForms.indexOf(r);return s[Math.min(i,s.length-1)]}(n,t,e)}}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6969],{1243:(e,t,n)=>{n.d(t,{A:()=>g});n(6540);var s=n(4164),r=n(7559),i=n(6972),a=n(9169),l=n(8774),o=n(1312),c=n(6025),d=n(4848);function u(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,d.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}const m={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function h(){const e=(0,c.Ay)("/");return(0,d.jsx)("li",{className:"breadcrumbs__item",children:(0,d.jsx)(l.A,{"aria-label":(0,o.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,d.jsx)(u,{className:m.breadcrumbHomeIcon})})})}const b={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function x(e){let{children:t,href:n,isLast:s}=e;const r="breadcrumbs__link";return s?(0,d.jsx)("span",{className:r,itemProp:"name",children:t}):n?(0,d.jsx)(l.A,{className:r,href:n,itemProp:"item",children:(0,d.jsx)("span",{itemProp:"name",children:t})}):(0,d.jsx)("span",{className:r,children:t})}function p(e){let{children:t,active:n,index:r,addMicrodata:i}=e;return(0,d.jsxs)("li",{...i&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},className:(0,s.A)("breadcrumbs__item",{"breadcrumbs__item--active":n}),children:[t,(0,d.jsx)("meta",{itemProp:"position",content:String(r+1)})]})}function g(){const e=(0,i.OF)(),t=(0,a.Dt)();return e?(0,d.jsx)("nav",{className:(0,s.A)(r.G.docs.docBreadcrumbs,b.breadcrumbsContainer),"aria-label":(0,o.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,d.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[t&&(0,d.jsx)(h,{}),e.map(((t,n)=>{const s=n===e.length-1,r="category"===t.type&&t.linkUnlisted?void 0:t.href;return(0,d.jsx)(p,{active:s,index:n,addMicrodata:!!r,children:(0,d.jsx)(x,{href:r,isLast:s,children:t.label})},n)}))]})}):null}},4136:(e,t,n)=>{n.r(t),n.d(t,{default:()=>w});n(6540);var s=n(5500),r=n(6972),i=n(6025),a=n(4164),l=n(8774),o=n(5846),c=n(6654),d=n(1312),u=n(1107);const m={cardContainer:"cardContainer_fWXF",cardTitle:"cardTitle_rnsV",cardDescription:"cardDescription_PWke"};var h=n(4848);function b(e){let{href:t,children:n}=e;return(0,h.jsx)(l.A,{href:t,className:(0,a.A)("card padding--lg",m.cardContainer),children:n})}function x(e){let{href:t,icon:n,title:s,description:r}=e;return(0,h.jsxs)(b,{href:t,children:[(0,h.jsxs)(u.A,{as:"h2",className:(0,a.A)("text--truncate",m.cardTitle),title:s,children:[n," ",s]}),r&&(0,h.jsx)("p",{className:(0,a.A)("text--truncate",m.cardDescription),title:r,children:r})]})}function p(e){let{item:t}=e;const n=(0,r.Nr)(t),s=function(){const{selectMessage:e}=(0,o.W)();return t=>e(t,(0,d.T)({message:"1 item|{count} items",id:"theme.docs.DocCard.categoryDescription.plurals",description:"The default description for a category card in the generated index about how many items this category includes"},{count:t}))}();return n?(0,h.jsx)(x,{href:n,icon:"\ud83d\uddc3\ufe0f",title:t.label,description:t.description??s(t.items.length)}):null}function g(e){let{item:t}=e;const n=(0,c.A)(t.href)?"\ud83d\udcc4\ufe0f":"\ud83d\udd17",s=(0,r.cC)(t.docId??void 0);return(0,h.jsx)(x,{href:t.href,icon:n,title:t.label,description:t.description??s?.description})}function v(e){let{item:t}=e;switch(t.type){case"link":return(0,h.jsx)(g,{item:t});case"category":return(0,h.jsx)(p,{item:t});default:throw new Error(`unknown item type ${JSON.stringify(t)}`)}}function f(e){let{className:t}=e;const n=(0,r.$S)();return(0,h.jsx)(j,{items:n.items,className:t})}function j(e){const{items:t,className:n}=e;if(!t)return(0,h.jsx)(f,{...e});const s=(0,r.d1)(t);return(0,h.jsx)("section",{className:(0,a.A)("row",n),children:s.map(((e,t)=>(0,h.jsx)("article",{className:"col col--6 margin-bottom--lg",children:(0,h.jsx)(v,{item:e})},t)))})}var A=n(7719),N=n(1878),T=n(4267),L=n(1243);const _={generatedIndexPage:"generatedIndexPage_vN6x",list:"list_eTzJ",title:"title_kItE"};function k(e){let{categoryGeneratedIndex:t}=e;return(0,h.jsx)(s.be,{title:t.title,description:t.description,keywords:t.keywords,image:(0,i.Ay)(t.image)})}function y(e){let{categoryGeneratedIndex:t}=e;const n=(0,r.$S)();return(0,h.jsxs)("div",{className:_.generatedIndexPage,children:[(0,h.jsx)(N.A,{}),(0,h.jsx)(L.A,{}),(0,h.jsx)(T.A,{}),(0,h.jsxs)("header",{children:[(0,h.jsx)(u.A,{as:"h1",className:_.title,children:t.title}),t.description&&(0,h.jsx)("p",{children:t.description})]}),(0,h.jsx)("article",{className:"margin-top--lg",children:(0,h.jsx)(j,{items:n.items,className:_.list})}),(0,h.jsx)("footer",{className:"margin-top--lg",children:(0,h.jsx)(A.A,{previous:t.navigation.previous,next:t.navigation.next})})]})}function w(e){return(0,h.jsxs)(h.Fragment,{children:[(0,h.jsx)(k,{...e}),(0,h.jsx)(y,{...e})]})}},7719:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(1312),r=n(9022),i=n(4848);function a(e){const{previous:t,next:n}=e;return(0,i.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,s.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[t&&(0,i.jsx)(r.A,{...t,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),n&&(0,i.jsx)(r.A,{...n,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},4267:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var s=n(4164),r=n(1312),i=n(7559),a=n(3025),l=n(4848);function o(e){let{className:t}=e;const n=(0,a.r)();return n.badge?(0,l.jsx)("span",{className:(0,s.A)(t,i.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,l.jsx)(r.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label},children:"Version: {versionLabel}"})}):null}},1878:(e,t,n)=>{n.d(t,{A:()=>p});n(6540);var s=n(4164),r=n(4586),i=n(8774),a=n(1312),l=n(4070),o=n(7559),c=n(3886),d=n(3025),u=n(4848);const m={unreleased:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){const t=m[e.versionMetadata.banner];return(0,u.jsx)(t,{...e})}function b(e){let{versionLabel:t,to:n,onClick:s}=e;return(0,u.jsx)(a.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:(0,u.jsx)("b",{children:(0,u.jsx)(i.A,{to:n,onClick:s,children:(0,u.jsx)(a.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function x(e){let{className:t,versionMetadata:n}=e;const{siteConfig:{title:i}}=(0,r.A)(),{pluginId:a}=(0,l.vT)({failfast:!0}),{savePreferredVersionName:d}=(0,c.g1)(a),{latestDocSuggestion:m,latestVersionSuggestion:x}=(0,l.HW)(a),p=m??(g=x).docs.find((e=>e.id===g.mainDocId));var g;return(0,u.jsxs)("div",{className:(0,s.A)(t,o.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,u.jsx)("div",{children:(0,u.jsx)(h,{siteTitle:i,versionMetadata:n})}),(0,u.jsx)("div",{className:"margin-top--md",children:(0,u.jsx)(b,{versionLabel:x.label,to:p.path,onClick:()=>d(x.name)})})]})}function p(e){let{className:t}=e;const n=(0,d.r)();return n.banner?(0,u.jsx)(x,{className:t,versionMetadata:n}):null}},9022:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(4164),r=n(8774),i=n(4848);function a(e){const{permalink:t,title:n,subLabel:a,isNext:l}=e;return(0,i.jsxs)(r.A,{className:(0,s.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[a&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:a}),(0,i.jsx)("div",{className:"pagination-nav__label",children:n})]})}},5846:(e,t,n)=>{n.d(t,{W:()=>c});var s=n(6540),r=n(4586);const i=["zero","one","two","few","many","other"];function a(e){return i.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:a(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,r.A)();return(0,s.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:a(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function c(){const e=o();return{selectMessage:(t,n)=>function(e,t,n){const s=e.split("|");if(1===s.length)return s[0];s.length>n.pluralForms.length&&console.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${s.length}: ${e}`);const r=n.select(t),i=n.pluralForms.indexOf(r);return s[Math.min(i,s.length-1)]}(n,t,e)}}}}]); \ No newline at end of file diff --git a/assets/js/150e319f.19180b4d.js b/assets/js/150e319f.19180b4d.js new file mode 100644 index 0000000000..672ba8e37e --- /dev/null +++ b/assets/js/150e319f.19180b4d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[809],{3889:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=c(4848),r=c(8453);const i={},o="api/model/contact",a={id:"reference/api/model/contact/index",title:"api/model/contact",description:"Index",source:"@site/docs/reference/api/model/contact/index.md",sourceDirName:"reference/api/model/contact",slug:"/reference/api/model/contact/",permalink:"/docs/reference/api/model/contact/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig"},next:{title:"Interface: BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory"}},s={},d=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"apimodelcontact",children:"api/model/contact"})}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>o,x:()=>a});var t=c(6540);const r={},i=t.createContext(r);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/150e319f.cad68f4a.js b/assets/js/150e319f.cad68f4a.js deleted file mode 100644 index 3a7316efd3..0000000000 --- a/assets/js/150e319f.cad68f4a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[809],{3889:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=c(4848),r=c(8453);const i={},o="api/model/contact",a={id:"reference/api/model/contact/index",title:"api/model/contact",description:"Index",source:"@site/docs/reference/api/model/contact/index.md",sourceDirName:"reference/api/model/contact",slug:"/reference/api/model/contact/",permalink:"/docs/reference/api/model/contact/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig"},next:{title:"Interface: BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory"}},s={},d=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"apimodelcontact",children:"api/model/contact"}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>o,x:()=>a});var t=c(6540);const r={},i=t.createContext(r);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/155c8334.0c549f4f.js b/assets/js/155c8334.0c549f4f.js new file mode 100644 index 0000000000..9e6086d881 --- /dev/null +++ b/assets/js/155c8334.0c549f4f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[283],{4319:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var o=c(4848),t=c(8453);const i={},s="Type Alias: AdvancedConfig",r={id:"reference/api/model/config/type-aliases/AdvancedConfig",title:"Type Alias: AdvancedConfig",description:"AdvancedConfig: ConfigObject & object",source:"@site/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",sourceDirName:"reference/api/model/config/type-aliases",slug:"/reference/api/model/config/type-aliases/AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook"},next:{title:"api/model/contact",permalink:"/docs/reference/api/model/contact/"}},a={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"licenseKey",id:"licensekey",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-advancedconfig",children:"Type Alias: AdvancedConfig"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AdvancedConfig"}),": ",(0,o.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,o.jsx)(n.code,{children:"ConfigObject"})})," & ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,o.jsx)(n.h3,{id:"licensekey",children:"licenseKey"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"licenseKey"}),": ",(0,o.jsx)(n.code,{children:"LicenseKeyConfig"})]}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>s,x:()=>r});var o=c(6540);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/155c8334.98b43b96.js b/assets/js/155c8334.98b43b96.js deleted file mode 100644 index ae66145ab4..0000000000 --- a/assets/js/155c8334.98b43b96.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[283],{4319:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var o=c(4848),t=c(8453);const i={},s="Type Alias: AdvancedConfig",a={id:"reference/api/model/config/type-aliases/AdvancedConfig",title:"Type Alias: AdvancedConfig",description:"AdvancedConfig: ConfigObject & object",source:"@site/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",sourceDirName:"reference/api/model/config/type-aliases",slug:"/reference/api/model/config/type-aliases/AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook"},next:{title:"api/model/contact",permalink:"/docs/reference/api/model/contact/"}},r={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"licenseKey",id:"licensekey",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-advancedconfig",children:"Type Alias: AdvancedConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AdvancedConfig"}),": ",(0,o.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,o.jsx)(n.code,{children:"ConfigObject"})})," & ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,o.jsx)(n.h3,{id:"licensekey",children:"licenseKey"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"licenseKey"}),": ",(0,o.jsx)(n.code,{children:"LicenseKeyConfig"})]}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>s,x:()=>a});var o=c(6540);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/171e0138.a0119660.js b/assets/js/171e0138.a0119660.js deleted file mode 100644 index 450b38af40..0000000000 --- a/assets/js/171e0138.a0119660.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5653],{809:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var s=r(4848),i=r(8453);const t={},o="Enumeration: ERROR_NAME",d={id:"reference/api/model/errors/enumerations/ERROR_NAME",title:"Enumeration: ERROR\\_NAME",description:"Enum of error names specific to this library",source:"@site/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",sourceDirName:"reference/api/model/errors/enumerations",slug:"/reference/api/model/errors/enumerations/ERROR_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode"},next:{title:"api/model/events",permalink:"/docs/reference/api/model/events/"}},c={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"BAD_STICKER_METADATA",id:"bad_sticker_metadata",level:3},{value:"FILE_NOT_FOUND",id:"file_not_found",level:3},{value:"INVALID_LABEL",id:"invalid_label",level:3},{value:"MEDIA_MISSING",id:"media_missing",level:3},{value:"MISSING_URL",id:"missing_url",level:3},{value:"NOT_MEDIA",id:"not_media",level:3},{value:"PAGE_CLOSED",id:"page_closed",level:3},{value:"SENDTEXT_FAILURE",id:"sendtext_failure",level:3},{value:"STATE_ERROR",id:"state_error",level:3},{value:"STICKER_NOT_DECRYPTED",id:"sticker_not_decrypted",level:3},{value:"STICKER_TOO_LARGE",id:"sticker_too_large",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"enumeration-error_name",children:"Enumeration: ERROR_NAME"}),"\n",(0,s.jsx)(n.p,{children:"Enum of error names specific to this library"}),"\n",(0,s.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,s.jsx)(n.h3,{id:"bad_sticker_metadata",children:"BAD_STICKER_METADATA"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"BAD_STICKER_METADATA"}),": ",(0,s.jsx)(n.code,{children:'"BAD_STICKER_METADATA"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sticker metadata parameter is wrong."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"file_not_found",children:"FILE_NOT_FOUND"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FILE_NOT_FOUND"}),": ",(0,s.jsx)(n.code,{children:'"FILE_NOT_FOUND"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"File was not found at given path."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"invalid_label",children:"INVALID_LABEL"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"INVALID_LABEL"}),": ",(0,s.jsx)(n.code,{children:'"INVALID_LABEL"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Label does not exist"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"media_missing",children:"MEDIA_MISSING"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MEDIA_MISSING"}),": ",(0,s.jsx)(n.code,{children:'"MEDIA_MISSING"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Expected media is missing."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"missing_url",children:"MISSING_URL"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MISSING_URL"}),": ",(0,s.jsx)(n.code,{children:'"MISSING_URL"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An expected URL is missing"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"not_media",children:"NOT_MEDIA"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NOT_MEDIA"}),": ",(0,s.jsx)(n.code,{children:'"NOT_MEDIA"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The message is not a media message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"page_closed",children:"PAGE_CLOSED"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"PAGE_CLOSED"}),": ",(0,s.jsx)(n.code,{children:'"PAGE_CLOSED"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The puppeteer page has been closed or the client has lost the connection with the page. This can happen if your computer/server has gone to sleep and waken up. Please restart your session."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendtext_failure",children:"SENDTEXT_FAILURE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SENDTEXT_FAILURE"}),": ",(0,s.jsx)(n.code,{children:'"SENDTEXT_FAILURE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unable to send text"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state_error",children:"STATE_ERROR"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STATE_ERROR"}),": ",(0,s.jsx)(n.code,{children:'"STATE_ERROR"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The client state is preventing the command from completing."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sticker_not_decrypted",children:"STICKER_NOT_DECRYPTED"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STICKER_NOT_DECRYPTED"}),": ",(0,s.jsx)(n.code,{children:'"STICKER_NOT_DECRYPTED"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The attempt to decrypt a sticker message has failed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sticker_too_large",children:"STICKER_TOO_LARGE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STICKER_TOO_LARGE"}),": ",(0,s.jsx)(n.code,{children:'"STICKER_TOO_LARGE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sticker file exceeds the maximum 1MB limit"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>d});var s=r(6540);const i={},t=s.createContext(i);function o(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/171e0138.e960842a.js b/assets/js/171e0138.e960842a.js new file mode 100644 index 0000000000..2acb0f9975 --- /dev/null +++ b/assets/js/171e0138.e960842a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5653],{809:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var s=r(4848),i=r(8453);const t={},d="Enumeration: ERROR_NAME",o={id:"reference/api/model/errors/enumerations/ERROR_NAME",title:"Enumeration: ERROR\\_NAME",description:"Enum of error names specific to this library",source:"@site/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",sourceDirName:"reference/api/model/errors/enumerations",slug:"/reference/api/model/errors/enumerations/ERROR_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode"},next:{title:"api/model/events",permalink:"/docs/reference/api/model/events/"}},c={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"BAD_STICKER_METADATA",id:"bad_sticker_metadata",level:3},{value:"FILE_NOT_FOUND",id:"file_not_found",level:3},{value:"INVALID_LABEL",id:"invalid_label",level:3},{value:"MEDIA_MISSING",id:"media_missing",level:3},{value:"MISSING_URL",id:"missing_url",level:3},{value:"NOT_MEDIA",id:"not_media",level:3},{value:"PAGE_CLOSED",id:"page_closed",level:3},{value:"SENDTEXT_FAILURE",id:"sendtext_failure",level:3},{value:"STATE_ERROR",id:"state_error",level:3},{value:"STICKER_NOT_DECRYPTED",id:"sticker_not_decrypted",level:3},{value:"STICKER_TOO_LARGE",id:"sticker_too_large",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"enumeration-error_name",children:"Enumeration: ERROR_NAME"})}),"\n",(0,s.jsx)(n.p,{children:"Enum of error names specific to this library"}),"\n",(0,s.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,s.jsx)(n.h3,{id:"bad_sticker_metadata",children:"BAD_STICKER_METADATA"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"BAD_STICKER_METADATA"}),": ",(0,s.jsx)(n.code,{children:'"BAD_STICKER_METADATA"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sticker metadata parameter is wrong."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"file_not_found",children:"FILE_NOT_FOUND"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FILE_NOT_FOUND"}),": ",(0,s.jsx)(n.code,{children:'"FILE_NOT_FOUND"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"File was not found at given path."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"invalid_label",children:"INVALID_LABEL"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"INVALID_LABEL"}),": ",(0,s.jsx)(n.code,{children:'"INVALID_LABEL"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Label does not exist"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"media_missing",children:"MEDIA_MISSING"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MEDIA_MISSING"}),": ",(0,s.jsx)(n.code,{children:'"MEDIA_MISSING"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Expected media is missing."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"missing_url",children:"MISSING_URL"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MISSING_URL"}),": ",(0,s.jsx)(n.code,{children:'"MISSING_URL"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An expected URL is missing"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"not_media",children:"NOT_MEDIA"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NOT_MEDIA"}),": ",(0,s.jsx)(n.code,{children:'"NOT_MEDIA"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The message is not a media message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"page_closed",children:"PAGE_CLOSED"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"PAGE_CLOSED"}),": ",(0,s.jsx)(n.code,{children:'"PAGE_CLOSED"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The puppeteer page has been closed or the client has lost the connection with the page. This can happen if your computer/server has gone to sleep and waken up. Please restart your session."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendtext_failure",children:"SENDTEXT_FAILURE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SENDTEXT_FAILURE"}),": ",(0,s.jsx)(n.code,{children:'"SENDTEXT_FAILURE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unable to send text"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state_error",children:"STATE_ERROR"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STATE_ERROR"}),": ",(0,s.jsx)(n.code,{children:'"STATE_ERROR"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The client state is preventing the command from completing."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sticker_not_decrypted",children:"STICKER_NOT_DECRYPTED"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STICKER_NOT_DECRYPTED"}),": ",(0,s.jsx)(n.code,{children:'"STICKER_NOT_DECRYPTED"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The attempt to decrypt a sticker message has failed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sticker_too_large",children:"STICKER_TOO_LARGE"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"STICKER_TOO_LARGE"}),": ",(0,s.jsx)(n.code,{children:'"STICKER_TOO_LARGE"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sticker file exceeds the maximum 1MB limit"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>o});var s=r(6540);const i={},t=s.createContext(i);function d(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17896441.1f139e5a.js b/assets/js/17896441.1f139e5a.js new file mode 100644 index 0000000000..085b9288e4 --- /dev/null +++ b/assets/js/17896441.1f139e5a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8401],{2234:(e,n,t)=>{t.d(n,{A:()=>c});t(6540);var s=t(4164),a=t(4084),i=t(7559),l=t(890),o=t(4848);function r(e){let{className:n}=e;return(0,o.jsx)(l.A,{type:"caution",title:(0,o.jsx)(a.Rc,{}),className:(0,s.A)(n,i.G.common.unlistedBanner),children:(0,o.jsx)(a.Uh,{})})}function c(e){return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(a.AE,{}),(0,o.jsx)(r,{...e})]})}},1689:(e,n,t)=>{t.d(n,{A:()=>d});t(6540);var s=t(4164),a=t(4084),i=t(7559),l=t(890),o=t(4848);function r(e){let{className:n}=e;return(0,o.jsx)(l.A,{type:"caution",title:(0,o.jsx)(a.Yh,{}),className:(0,s.A)(n,i.G.common.draftBanner),children:(0,o.jsx)(a.TT,{})})}var c=t(2234);function d(e){let{metadata:n}=e;const{unlisted:t,frontMatter:s}=n;return(0,o.jsxs)(o.Fragment,{children:[(t||s.unlisted)&&(0,o.jsx)(c.A,{}),s.draft&&(0,o.jsx)(r,{})]})}},1243:(e,n,t)=>{t.d(n,{A:()=>g});t(6540);var s=t(4164),a=t(7559),i=t(6972),l=t(9169),o=t(8774),r=t(1312),c=t(6025),d=t(4848);function u(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,d.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}const m={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function h(){const e=(0,c.Ay)("/");return(0,d.jsx)("li",{className:"breadcrumbs__item",children:(0,d.jsx)(o.A,{"aria-label":(0,r.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,d.jsx)(u,{className:m.breadcrumbHomeIcon})})})}const v={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function x(e){let{children:n,href:t,isLast:s}=e;const a="breadcrumbs__link";return s?(0,d.jsx)("span",{className:a,itemProp:"name",children:n}):t?(0,d.jsx)(o.A,{className:a,href:t,itemProp:"item",children:(0,d.jsx)("span",{itemProp:"name",children:n})}):(0,d.jsx)("span",{className:a,children:n})}function b(e){let{children:n,active:t,index:a,addMicrodata:i}=e;return(0,d.jsxs)("li",{...i&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},className:(0,s.A)("breadcrumbs__item",{"breadcrumbs__item--active":t}),children:[n,(0,d.jsx)("meta",{itemProp:"position",content:String(a+1)})]})}function g(){const e=(0,i.OF)(),n=(0,l.Dt)();return e?(0,d.jsx)("nav",{className:(0,s.A)(a.G.docs.docBreadcrumbs,v.breadcrumbsContainer),"aria-label":(0,r.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,d.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[n&&(0,d.jsx)(h,{}),e.map(((n,t)=>{const s=t===e.length-1,a="category"===n.type&&n.linkUnlisted?void 0:n.href;return(0,d.jsx)(b,{active:s,index:t,addMicrodata:!!a,children:(0,d.jsx)(x,{href:a,isLast:s,children:n.label})},t)}))]})}):null}},833:(e,n,t)=>{t.r(n),t.d(n,{default:()=>F});var s=t(6540),a=t(5500),i=t(9532),l=t(4848);const o=s.createContext(null);function r(e){let{children:n,content:t}=e;const a=function(e){return(0,s.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(t);return(0,l.jsx)(o.Provider,{value:a,children:n})}function c(){const e=(0,s.useContext)(o);if(null===e)throw new i.dV("DocProvider");return e}function d(){const{metadata:e,frontMatter:n,assets:t}=c();return(0,l.jsx)(a.be,{title:e.title,description:e.description,keywords:n.keywords,image:t.image??n.image})}var u=t(4164),m=t(4581),h=t(7719);function v(){const{metadata:e}=c();return(0,l.jsx)(h.A,{previous:e.previous,next:e.next})}var x=t(1878),b=t(4267),g=t(7559),p=t(2053),f=t(4336);function j(){const{metadata:e}=c(),{editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s,tags:a}=e,i=a.length>0,o=!!(n||t||s);return i||o?(0,l.jsxs)("footer",{className:(0,u.A)(g.G.docs.docFooter,"docusaurus-mt-lg"),children:[i&&(0,l.jsx)("div",{className:(0,u.A)("row margin-top--sm",g.G.docs.docFooterTagsRow),children:(0,l.jsx)("div",{className:"col",children:(0,l.jsx)(p.A,{tags:a})})}),o&&(0,l.jsx)(f.A,{className:(0,u.A)("margin-top--sm",g.G.docs.docFooterEditMetaRow),editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s})]}):null}var A=t(1422),N=t(5195),L=t(1312);const C={tocCollapsibleButton:"tocCollapsibleButton_TO0P",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_MG3E"};function _(e){let{collapsed:n,...t}=e;return(0,l.jsx)("button",{type:"button",...t,className:(0,u.A)("clean-btn",C.tocCollapsibleButton,!n&&C.tocCollapsibleButtonExpanded,t.className),children:(0,l.jsx)(L.A,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})})}const T={tocCollapsible:"tocCollapsible_ETCw",tocCollapsibleContent:"tocCollapsibleContent_vkbj",tocCollapsibleExpanded:"tocCollapsibleExpanded_sAul"};function k(e){let{toc:n,className:t,minHeadingLevel:s,maxHeadingLevel:a}=e;const{collapsed:i,toggleCollapsed:o}=(0,A.u)({initialState:!0});return(0,l.jsxs)("div",{className:(0,u.A)(T.tocCollapsible,!i&&T.tocCollapsibleExpanded,t),children:[(0,l.jsx)(_,{collapsed:i,onClick:o}),(0,l.jsx)(A.N,{lazy:!0,className:T.tocCollapsibleContent,collapsed:i,children:(0,l.jsx)(N.A,{toc:n,minHeadingLevel:s,maxHeadingLevel:a})})]})}const H={tocMobile:"tocMobile_ITEo"};function y(){const{toc:e,frontMatter:n}=c();return(0,l.jsx)(k,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:(0,u.A)(g.G.docs.docTocMobile,H.tocMobile)})}var M=t(7763);function B(){const{toc:e,frontMatter:n}=c();return(0,l.jsx)(M.A,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:g.G.docs.docTocDesktop})}var I=t(1107),w=t(8509);function E(e){let{children:n}=e;const t=function(){const{metadata:e,frontMatter:n,contentTitle:t}=c();return n.hide_title||void 0!==t?null:e.title}();return(0,l.jsxs)("div",{className:(0,u.A)(g.G.docs.docMarkdown,"markdown"),children:[t&&(0,l.jsx)("header",{children:(0,l.jsx)(I.A,{as:"h1",children:t})}),(0,l.jsx)(w.A,{children:n})]})}var V=t(1243),O=t(1689);const R={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function G(e){let{children:n}=e;const t=function(){const{frontMatter:e,toc:n}=c(),t=(0,m.l)(),s=e.hide_table_of_contents,a=!s&&n.length>0;return{hidden:s,mobile:a?(0,l.jsx)(y,{}):void 0,desktop:!a||"desktop"!==t&&"ssr"!==t?void 0:(0,l.jsx)(B,{})}}(),{metadata:s}=c();return(0,l.jsxs)("div",{className:"row",children:[(0,l.jsxs)("div",{className:(0,u.A)("col",!t.hidden&&R.docItemCol),children:[(0,l.jsx)(O.A,{metadata:s}),(0,l.jsx)(x.A,{}),(0,l.jsxs)("div",{className:R.docItemContainer,children:[(0,l.jsxs)("article",{children:[(0,l.jsx)(V.A,{}),(0,l.jsx)(b.A,{}),t.mobile,(0,l.jsx)(E,{children:n}),(0,l.jsx)(j,{})]}),(0,l.jsx)(v,{})]})]}),t.desktop&&(0,l.jsx)("div",{className:"col col--3",children:t.desktop})]})}function F(e){const n=`docs-doc-id-${e.content.metadata.id}`,t=e.content;return(0,l.jsx)(r,{content:e.content,children:(0,l.jsxs)(a.e3,{className:n,children:[(0,l.jsx)(d,{}),(0,l.jsx)(G,{children:(0,l.jsx)(t,{})})]})})}},7719:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var s=t(1312),a=t(9022),i=t(4848);function l(e){const{previous:n,next:t}=e;return(0,i.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,s.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[n&&(0,i.jsx)(a.A,{...n,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),t&&(0,i.jsx)(a.A,{...t,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},4267:(e,n,t)=>{t.d(n,{A:()=>r});t(6540);var s=t(4164),a=t(1312),i=t(7559),l=t(3025),o=t(4848);function r(e){let{className:n}=e;const t=(0,l.r)();return t.badge?(0,o.jsx)("span",{className:(0,s.A)(n,i.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,o.jsx)(a.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:t.label},children:"Version: {versionLabel}"})}):null}},1878:(e,n,t)=>{t.d(n,{A:()=>b});t(6540);var s=t(4164),a=t(4586),i=t(8774),l=t(1312),o=t(4070),r=t(7559),c=t(3886),d=t(3025),u=t(4848);const m={unreleased:function(e){let{siteTitle:n,versionMetadata:t}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:n,versionLabel:(0,u.jsx)("b",{children:t.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:n,versionMetadata:t}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:n,versionLabel:(0,u.jsx)("b",{children:t.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){const n=m[e.versionMetadata.banner];return(0,u.jsx)(n,{...e})}function v(e){let{versionLabel:n,to:t,onClick:s}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:n,latestVersionLink:(0,u.jsx)("b",{children:(0,u.jsx)(i.A,{to:t,onClick:s,children:(0,u.jsx)(l.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function x(e){let{className:n,versionMetadata:t}=e;const{siteConfig:{title:i}}=(0,a.A)(),{pluginId:l}=(0,o.vT)({failfast:!0}),{savePreferredVersionName:d}=(0,c.g1)(l),{latestDocSuggestion:m,latestVersionSuggestion:x}=(0,o.HW)(l),b=m??(g=x).docs.find((e=>e.id===g.mainDocId));var g;return(0,u.jsxs)("div",{className:(0,s.A)(n,r.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,u.jsx)("div",{children:(0,u.jsx)(h,{siteTitle:i,versionMetadata:t})}),(0,u.jsx)("div",{className:"margin-top--md",children:(0,u.jsx)(v,{versionLabel:x.label,to:b.path,onClick:()=>d(x.name)})})]})}function b(e){let{className:n}=e;const t=(0,d.r)();return t.banner?(0,u.jsx)(x,{className:n,versionMetadata:t}):null}},9022:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var s=t(4164),a=t(8774),i=t(4848);function l(e){const{permalink:n,title:t,subLabel:l,isNext:o}=e;return(0,i.jsxs)(a.A,{className:(0,s.A)("pagination-nav__link",o?"pagination-nav__link--next":"pagination-nav__link--prev"),to:n,children:[l&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:l}),(0,i.jsx)("div",{className:"pagination-nav__label",children:t})]})}},7763:(e,n,t)=>{t.d(n,{A:()=>c});t(6540);var s=t(4164),a=t(5195);const i={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var l=t(4848);const o="table-of-contents__link toc-highlight",r="table-of-contents__link--active";function c(e){let{className:n,...t}=e;return(0,l.jsx)("div",{className:(0,s.A)(i.tableOfContents,"thin-scrollbar",n),children:(0,l.jsx)(a.A,{...t,linkClassName:o,linkActiveClassName:r})})}},5195:(e,n,t)=>{t.d(n,{A:()=>x});var s=t(6540),a=t(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),t=Array(7).fill(-1);n.forEach(((e,n)=>{const s=t.slice(2,e.level);e.parentIndex=Math.max(...s),t[e.level]=n}));const s=[];return n.forEach((e=>{const{parentIndex:t,...a}=e;t>=0?n[t].children.push(a):s.push(a)})),s}function l(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:s}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:t,maxHeadingLevel:s});return function(e){return e.level>=t&&e.level<=s}(e)?[{...e,children:n}]:n}))}function o(e){const n=e.getBoundingClientRect();return n.top===n.bottom?o(e.parentNode):n}function r(e,n){let{anchorTopOffset:t}=n;const s=e.find((e=>o(e).top>=t));if(s){return function(e){return e.top>0&&e.bottom{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,s.useRef)(void 0),t=c();(0,s.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:s,linkActiveClassName:a,minHeadingLevel:i,maxHeadingLevel:l}=e;function o(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(s),o=function(e){let{minHeadingLevel:n,maxHeadingLevel:t}=e;const s=[];for(let a=n;a<=t;a+=1)s.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(s.join()))}({minHeadingLevel:i,maxHeadingLevel:l}),c=r(o,{anchorTopOffset:t.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",o),document.addEventListener("resize",o),o(),()=>{document.removeEventListener("scroll",o),document.removeEventListener("resize",o)}}),[e,t])}var u=t(8774),m=t(4848);function h(e){let{toc:n,className:t,linkClassName:s,isChild:a}=e;return n.length?(0,m.jsx)("ul",{className:a?void 0:t,children:n.map((e=>(0,m.jsxs)("li",{children:[(0,m.jsx)(u.A,{to:`#${e.id}`,className:s??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,m.jsx)(h,{isChild:!0,toc:e.children,className:t,linkClassName:s})]},e.id)))}):null}const v=s.memo(h);function x(e){let{toc:n,className:t="table-of-contents table-of-contents__left-border",linkClassName:o="table-of-contents__link",linkActiveClassName:r,minHeadingLevel:c,maxHeadingLevel:u,...h}=e;const x=(0,a.p)(),b=c??x.tableOfContents.minHeadingLevel,g=u??x.tableOfContents.maxHeadingLevel,p=function(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:a}=e;return(0,s.useMemo)((()=>l({toc:i(n),minHeadingLevel:t,maxHeadingLevel:a})),[n,t,a])}({toc:n,minHeadingLevel:b,maxHeadingLevel:g});return d((0,s.useMemo)((()=>{if(o&&r)return{linkClassName:o,linkActiveClassName:r,minHeadingLevel:b,maxHeadingLevel:g}}),[o,r,b,g])),(0,m.jsx)(v,{toc:p,className:t,linkClassName:o,...h})}},6133:(e,n,t)=>{t.d(n,{A:()=>o});t(6540);var s=t(4164),a=t(8774);const i={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var l=t(4848);function o(e){let{permalink:n,label:t,count:o,description:r}=e;return(0,l.jsxs)(a.A,{href:n,title:r,className:(0,s.A)(i.tag,o?i.tagWithCount:i.tagRegular),children:[t,o&&(0,l.jsx)("span",{children:o})]})}},2053:(e,n,t)=>{t.d(n,{A:()=>r});t(6540);var s=t(4164),a=t(1312),i=t(6133);const l={tags:"tags_jXut",tag:"tag_QGVx"};var o=t(4848);function r(e){let{tags:n}=e;return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("b",{children:(0,o.jsx)(a.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,o.jsx)("ul",{className:(0,s.A)(l.tags,"padding--none","margin-left--sm"),children:n.map((e=>(0,o.jsx)("li",{className:l.tag,children:(0,o.jsx)(i.A,{...e})},e.permalink)))})]})}},4084:(e,n,t)=>{t.d(n,{AE:()=>r,Rc:()=>l,TT:()=>d,Uh:()=>o,Yh:()=>c});t(6540);var s=t(1312),a=t(5260),i=t(4848);function l(){return(0,i.jsx)(s.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function o(){return(0,i.jsx)(s.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function r(){return(0,i.jsx)(a.A,{children:(0,i.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function c(){return(0,i.jsx)(s.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function d(){return(0,i.jsx)(s.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}},4037:(e,n,t)=>{t.d(n,{A:()=>a});t(6540);var s=t(3028);t(4848);const a={...s.A,license:s.A.note}},890:(e,n,t)=>{t.d(n,{A:()=>i});t(6540);var s=t(4741),a=t(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,a.jsx)(s.A,{icon:"\ud83c\udfc5",...e}):(0,a.jsx)(a.Fragment,{children:(0,a.jsx)(s.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/17896441.b553e71a.js b/assets/js/17896441.b553e71a.js deleted file mode 100644 index ecffce1753..0000000000 --- a/assets/js/17896441.b553e71a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8401],{1243:(e,n,t)=>{t.d(n,{A:()=>g});t(6540);var s=t(4164),a=t(7559),i=t(4142),l=t(9169),o=t(8774),r=t(1312),c=t(6025),d=t(4848);function u(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,d.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}const m={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function h(){const e=(0,c.Ay)("/");return(0,d.jsx)("li",{className:"breadcrumbs__item",children:(0,d.jsx)(o.A,{"aria-label":(0,r.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,d.jsx)(u,{className:m.breadcrumbHomeIcon})})})}const v={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function x(e){let{children:n,href:t,isLast:s}=e;const a="breadcrumbs__link";return s?(0,d.jsx)("span",{className:a,itemProp:"name",children:n}):t?(0,d.jsx)(o.A,{className:a,href:t,itemProp:"item",children:(0,d.jsx)("span",{itemProp:"name",children:n})}):(0,d.jsx)("span",{className:a,children:n})}function b(e){let{children:n,active:t,index:a,addMicrodata:i}=e;return(0,d.jsxs)("li",{...i&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},className:(0,s.A)("breadcrumbs__item",{"breadcrumbs__item--active":t}),children:[n,(0,d.jsx)("meta",{itemProp:"position",content:String(a+1)})]})}function g(){const e=(0,i.OF)(),n=(0,l.Dt)();return e?(0,d.jsx)("nav",{className:(0,s.A)(a.G.docs.docBreadcrumbs,v.breadcrumbsContainer),"aria-label":(0,r.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,d.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[n&&(0,d.jsx)(h,{}),e.map(((n,t)=>{const s=t===e.length-1,a="category"===n.type&&n.linkUnlisted?void 0:n.href;return(0,d.jsx)(b,{active:s,index:t,addMicrodata:!!a,children:(0,d.jsx)(x,{href:a,isLast:s,children:n.label})},t)}))]})}):null}},6011:(e,n,t)=>{t.r(n),t.d(n,{default:()=>S});var s=t(6540),a=t(5500),i=t(9532),l=t(4848);const o=s.createContext(null);function r(e){let{children:n,content:t}=e;const a=function(e){return(0,s.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(t);return(0,l.jsx)(o.Provider,{value:a,children:n})}function c(){const e=(0,s.useContext)(o);if(null===e)throw new i.dV("DocProvider");return e}function d(){const{metadata:e,frontMatter:n,assets:t}=c();return(0,l.jsx)(a.be,{title:e.title,description:e.description,keywords:n.keywords,image:t.image??n.image})}var u=t(4164),m=t(4581),h=t(7719);function v(){const{metadata:e}=c();return(0,l.jsx)(h.A,{previous:e.previous,next:e.next})}var x=t(1878),b=t(4267),g=t(7559),p=t(2053),f=t(4336);function j(){const{metadata:e}=c(),{editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s,tags:a}=e,i=a.length>0,o=!!(n||t||s);return i||o?(0,l.jsxs)("footer",{className:(0,u.A)(g.G.docs.docFooter,"docusaurus-mt-lg"),children:[i&&(0,l.jsx)("div",{className:(0,u.A)("row margin-top--sm",g.G.docs.docFooterTagsRow),children:(0,l.jsx)("div",{className:"col",children:(0,l.jsx)(p.A,{tags:a})})}),o&&(0,l.jsx)(f.A,{className:(0,u.A)("margin-top--sm",g.G.docs.docFooterEditMetaRow),editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s})]}):null}var A=t(1422),C=t(5195),L=t(1312);const N={tocCollapsibleButton:"tocCollapsibleButton_TO0P",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_MG3E"};function _(e){let{collapsed:n,...t}=e;return(0,l.jsx)("button",{type:"button",...t,className:(0,u.A)("clean-btn",N.tocCollapsibleButton,!n&&N.tocCollapsibleButtonExpanded,t.className),children:(0,l.jsx)(L.A,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})})}const k={tocCollapsible:"tocCollapsible_ETCw",tocCollapsibleContent:"tocCollapsibleContent_vkbj",tocCollapsibleExpanded:"tocCollapsibleExpanded_sAul"};function T(e){let{toc:n,className:t,minHeadingLevel:s,maxHeadingLevel:a}=e;const{collapsed:i,toggleCollapsed:o}=(0,A.u)({initialState:!0});return(0,l.jsxs)("div",{className:(0,u.A)(k.tocCollapsible,!i&&k.tocCollapsibleExpanded,t),children:[(0,l.jsx)(_,{collapsed:i,onClick:o}),(0,l.jsx)(A.N,{lazy:!0,className:k.tocCollapsibleContent,collapsed:i,children:(0,l.jsx)(C.A,{toc:n,minHeadingLevel:s,maxHeadingLevel:a})})]})}const H={tocMobile:"tocMobile_ITEo"};function M(){const{toc:e,frontMatter:n}=c();return(0,l.jsx)(T,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:(0,u.A)(g.G.docs.docTocMobile,H.tocMobile)})}var y=t(7763);function I(){const{toc:e,frontMatter:n}=c();return(0,l.jsx)(y.A,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:g.G.docs.docTocDesktop})}var w=t(1107),E=t(8509);function B(e){let{children:n}=e;const t=function(){const{metadata:e,frontMatter:n,contentTitle:t}=c();return n.hide_title||void 0!==t?null:e.title}();return(0,l.jsxs)("div",{className:(0,u.A)(g.G.docs.docMarkdown,"markdown"),children:[t&&(0,l.jsx)("header",{children:(0,l.jsx)(w.A,{as:"h1",children:t})}),(0,l.jsx)(E.A,{children:n})]})}var O=t(1243),V=t(996);const G={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function R(e){let{children:n}=e;const t=function(){const{frontMatter:e,toc:n}=c(),t=(0,m.l)(),s=e.hide_table_of_contents,a=!s&&n.length>0;return{hidden:s,mobile:a?(0,l.jsx)(M,{}):void 0,desktop:!a||"desktop"!==t&&"ssr"!==t?void 0:(0,l.jsx)(I,{})}}(),{metadata:{unlisted:s}}=c();return(0,l.jsxs)("div",{className:"row",children:[(0,l.jsxs)("div",{className:(0,u.A)("col",!t.hidden&&G.docItemCol),children:[s&&(0,l.jsx)(V.A,{}),(0,l.jsx)(x.A,{}),(0,l.jsxs)("div",{className:G.docItemContainer,children:[(0,l.jsxs)("article",{children:[(0,l.jsx)(O.A,{}),(0,l.jsx)(b.A,{}),t.mobile,(0,l.jsx)(B,{children:n}),(0,l.jsx)(j,{})]}),(0,l.jsx)(v,{})]})]}),t.desktop&&(0,l.jsx)("div",{className:"col col--3",children:t.desktop})]})}function S(e){const n=`docs-doc-id-${e.content.metadata.id}`,t=e.content;return(0,l.jsx)(r,{content:e.content,children:(0,l.jsxs)(a.e3,{className:n,children:[(0,l.jsx)(d,{}),(0,l.jsx)(R,{children:(0,l.jsx)(t,{})})]})})}},7719:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var s=t(1312),a=t(9022),i=t(4848);function l(e){const{previous:n,next:t}=e;return(0,i.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,s.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[n&&(0,i.jsx)(a.A,{...n,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),t&&(0,i.jsx)(a.A,{...t,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},4267:(e,n,t)=>{t.d(n,{A:()=>r});t(6540);var s=t(4164),a=t(1312),i=t(7559),l=t(2252),o=t(4848);function r(e){let{className:n}=e;const t=(0,l.r)();return t.badge?(0,o.jsx)("span",{className:(0,s.A)(n,i.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,o.jsx)(a.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:t.label},children:"Version: {versionLabel}"})}):null}},1878:(e,n,t)=>{t.d(n,{A:()=>b});t(6540);var s=t(4164),a=t(4586),i=t(8774),l=t(1312),o=t(4070),r=t(7559),c=t(5597),d=t(2252),u=t(4848);const m={unreleased:function(e){let{siteTitle:n,versionMetadata:t}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:n,versionLabel:(0,u.jsx)("b",{children:t.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:n,versionMetadata:t}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:n,versionLabel:(0,u.jsx)("b",{children:t.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){const n=m[e.versionMetadata.banner];return(0,u.jsx)(n,{...e})}function v(e){let{versionLabel:n,to:t,onClick:s}=e;return(0,u.jsx)(l.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:n,latestVersionLink:(0,u.jsx)("b",{children:(0,u.jsx)(i.A,{to:t,onClick:s,children:(0,u.jsx)(l.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function x(e){let{className:n,versionMetadata:t}=e;const{siteConfig:{title:i}}=(0,a.A)(),{pluginId:l}=(0,o.vT)({failfast:!0}),{savePreferredVersionName:d}=(0,c.g1)(l),{latestDocSuggestion:m,latestVersionSuggestion:x}=(0,o.HW)(l),b=m??(g=x).docs.find((e=>e.id===g.mainDocId));var g;return(0,u.jsxs)("div",{className:(0,s.A)(n,r.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,u.jsx)("div",{children:(0,u.jsx)(h,{siteTitle:i,versionMetadata:t})}),(0,u.jsx)("div",{className:"margin-top--md",children:(0,u.jsx)(v,{versionLabel:x.label,to:b.path,onClick:()=>d(x.name)})})]})}function b(e){let{className:n}=e;const t=(0,d.r)();return t.banner?(0,u.jsx)(x,{className:n,versionMetadata:t}):null}},9022:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var s=t(4164),a=t(8774),i=t(4848);function l(e){const{permalink:n,title:t,subLabel:l,isNext:o}=e;return(0,i.jsxs)(a.A,{className:(0,s.A)("pagination-nav__link",o?"pagination-nav__link--next":"pagination-nav__link--prev"),to:n,children:[l&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:l}),(0,i.jsx)("div",{className:"pagination-nav__label",children:t})]})}},7763:(e,n,t)=>{t.d(n,{A:()=>c});t(6540);var s=t(4164),a=t(5195);const i={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var l=t(4848);const o="table-of-contents__link toc-highlight",r="table-of-contents__link--active";function c(e){let{className:n,...t}=e;return(0,l.jsx)("div",{className:(0,s.A)(i.tableOfContents,"thin-scrollbar",n),children:(0,l.jsx)(a.A,{...t,linkClassName:o,linkActiveClassName:r})})}},5195:(e,n,t)=>{t.d(n,{A:()=>x});var s=t(6540),a=t(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),t=Array(7).fill(-1);n.forEach(((e,n)=>{const s=t.slice(2,e.level);e.parentIndex=Math.max(...s),t[e.level]=n}));const s=[];return n.forEach((e=>{const{parentIndex:t,...a}=e;t>=0?n[t].children.push(a):s.push(a)})),s}function l(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:s}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:t,maxHeadingLevel:s});return function(e){return e.level>=t&&e.level<=s}(e)?[{...e,children:n}]:n}))}function o(e){const n=e.getBoundingClientRect();return n.top===n.bottom?o(e.parentNode):n}function r(e,n){let{anchorTopOffset:t}=n;const s=e.find((e=>o(e).top>=t));if(s){return function(e){return e.top>0&&e.bottom{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,s.useRef)(void 0),t=c();(0,s.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:s,linkActiveClassName:a,minHeadingLevel:i,maxHeadingLevel:l}=e;function o(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(s),o=function(e){let{minHeadingLevel:n,maxHeadingLevel:t}=e;const s=[];for(let a=n;a<=t;a+=1)s.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(s.join()))}({minHeadingLevel:i,maxHeadingLevel:l}),c=r(o,{anchorTopOffset:t.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",o),document.addEventListener("resize",o),o(),()=>{document.removeEventListener("scroll",o),document.removeEventListener("resize",o)}}),[e,t])}var u=t(8774),m=t(4848);function h(e){let{toc:n,className:t,linkClassName:s,isChild:a}=e;return n.length?(0,m.jsx)("ul",{className:a?void 0:t,children:n.map((e=>(0,m.jsxs)("li",{children:[(0,m.jsx)(u.A,{to:`#${e.id}`,className:s??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,m.jsx)(h,{isChild:!0,toc:e.children,className:t,linkClassName:s})]},e.id)))}):null}const v=s.memo(h);function x(e){let{toc:n,className:t="table-of-contents table-of-contents__left-border",linkClassName:o="table-of-contents__link",linkActiveClassName:r,minHeadingLevel:c,maxHeadingLevel:u,...h}=e;const x=(0,a.p)(),b=c??x.tableOfContents.minHeadingLevel,g=u??x.tableOfContents.maxHeadingLevel,p=function(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:a}=e;return(0,s.useMemo)((()=>l({toc:i(n),minHeadingLevel:t,maxHeadingLevel:a})),[n,t,a])}({toc:n,minHeadingLevel:b,maxHeadingLevel:g});return d((0,s.useMemo)((()=>{if(o&&r)return{linkClassName:o,linkActiveClassName:r,minHeadingLevel:b,maxHeadingLevel:g}}),[o,r,b,g])),(0,m.jsx)(v,{toc:p,className:t,linkClassName:o,...h})}},6133:(e,n,t)=>{t.d(n,{A:()=>o});t(6540);var s=t(4164),a=t(8774);const i={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var l=t(4848);function o(e){let{permalink:n,label:t,count:o,description:r}=e;return(0,l.jsxs)(a.A,{href:n,title:r,className:(0,s.A)(i.tag,o?i.tagWithCount:i.tagRegular),children:[t,o&&(0,l.jsx)("span",{children:o})]})}},2053:(e,n,t)=>{t.d(n,{A:()=>r});t(6540);var s=t(4164),a=t(1312),i=t(6133);const l={tags:"tags_jXut",tag:"tag_QGVx"};var o=t(4848);function r(e){let{tags:n}=e;return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("b",{children:(0,o.jsx)(a.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,o.jsx)("ul",{className:(0,s.A)(l.tags,"padding--none","margin-left--sm"),children:n.map((e=>(0,o.jsx)("li",{className:l.tag,children:(0,o.jsx)(i.A,{...e})},e.permalink)))})]})}},996:(e,n,t)=>{t.d(n,{A:()=>h});t(6540);var s=t(4164),a=t(1312),i=t(5260),l=t(4848);function o(){return(0,l.jsx)(a.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function r(){return(0,l.jsx)(a.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function c(){return(0,l.jsx)(i.A,{children:(0,l.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}var d=t(7559),u=t(890);function m(e){let{className:n}=e;return(0,l.jsx)(u.A,{type:"caution",title:(0,l.jsx)(o,{}),className:(0,s.A)(n,d.G.common.unlistedBanner),children:(0,l.jsx)(r,{})})}function h(e){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(c,{}),(0,l.jsx)(m,{...e})]})}},4037:(e,n,t)=>{t.d(n,{A:()=>a});t(6540);var s=t(3028);t(4848);const a={...s.A,license:s.A.note}},890:(e,n,t)=>{t.d(n,{A:()=>i});t(6540);var s=t(4741),a=t(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,a.jsx)(s.A,{icon:"\ud83c\udfc5",...e}):(0,a.jsx)(a.Fragment,{children:(0,a.jsx)(s.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/18336523.45f8debb.js b/assets/js/18336523.45f8debb.js deleted file mode 100644 index 0c37d66458..0000000000 --- a/assets/js/18336523.45f8debb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[240],{8895:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var r=t(4848),s=t(8453);const o={},c="logging/custom_transport",i={id:"reference/logging/custom_transport/index",title:"logging/custom\\_transport",description:"Index",source:"@site/docs/reference/logging/custom_transport/index.md",sourceDirName:"reference/logging/custom_transport",slug:"/reference/logging/custom_transport/",permalink:"/docs/reference/logging/custom_transport/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: getAndInjectLicense()",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense"},next:{title:"Class: LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport"}},a={},l=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3}];function u(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"loggingcustom_transport",children:"logging/custom_transport"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:"LogToEvTransport"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:"NoOpTransport"})}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>i});var r=t(6540);const s={},o=r.createContext(s);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18336523.da53d01f.js b/assets/js/18336523.da53d01f.js new file mode 100644 index 0000000000..5ed0970c26 --- /dev/null +++ b/assets/js/18336523.da53d01f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[240],{8895:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const o={},c="logging/custom_transport",a={id:"reference/logging/custom_transport/index",title:"logging/custom\\_transport",description:"Index",source:"@site/docs/reference/logging/custom_transport/index.md",sourceDirName:"reference/logging/custom_transport",slug:"/reference/logging/custom_transport/",permalink:"/docs/reference/logging/custom_transport/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: getAndInjectLicense()",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense"},next:{title:"Class: LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport"}},i={},l=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"loggingcustom_transport",children:"logging/custom_transport"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:"LogToEvTransport"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/NoOpTransport",children:"NoOpTransport"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var r=t(6540);const s={},o=r.createContext(s);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18ad8d0a.a3fb4b8e.js b/assets/js/18ad8d0a.a3fb4b8e.js new file mode 100644 index 0000000000..d7886fa5b2 --- /dev/null +++ b/assets/js/18ad8d0a.a3fb4b8e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[974],{4123:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=s(4848),a=s(8453);const o={},c="Launch Events",i={id:"configuration/launch-events",title:"Launch Events",description:"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:",source:"@site/docs/configuration/launch-events.md",sourceDirName:"configuration",slug:"/configuration/launch-events",permalink:"/docs/configuration/launch-events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/launch-events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Capturing the session data",permalink:"/docs/configuration/capture-sd"},next:{title:"Licensed Features",permalink:"/docs/configuration/licensed-features"}},r={},l=[];function d(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"launch-events",children:"Launch Events"})}),"\n",(0,t.jsxs)(n.p,{children:["When you call [create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter ",(0,t.jsx)(n.a,{href:"/TODO",children:(0,t.jsx)(n.code,{children:"ev"})}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\n\nev.on('event', callback)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The event you want to listen to is in the format of [namespace].[sessionId]"}),"\n",(0,t.jsx)(n.p,{children:"The event can include wildcards."}),"\n",(0,t.jsxs)(n.p,{children:["For example, to listen to all qr code events, the event will be ",(0,t.jsx)(n.code,{children:"qr.**"}),". e.g:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('qr.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all sessionData events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('sessionData.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events from session1"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.session1',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**', (data, sessionId, namespace) => {\n\n console.log(`${namespace} event detected for session ${sessionId}`, data)\n\n});\n"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>i});var t=s(6540);const a={},o=t.createContext(a);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18ad8d0a.c79f3890.js b/assets/js/18ad8d0a.c79f3890.js deleted file mode 100644 index a957820c04..0000000000 --- a/assets/js/18ad8d0a.c79f3890.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[974],{4123:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=s(4848),a=s(8453);const o={},c="Launch Events",i={id:"configuration/launch-events",title:"Launch Events",description:"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:",source:"@site/docs/configuration/launch-events.md",sourceDirName:"configuration",slug:"/configuration/launch-events",permalink:"/docs/configuration/launch-events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/launch-events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Capturing the session data",permalink:"/docs/configuration/capture-sd"},next:{title:"Licensed Features",permalink:"/docs/configuration/licensed-features"}},r={},l=[];function d(e){const n={a:"a",code:"code",h1:"h1",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"launch-events",children:"Launch Events"}),"\n",(0,t.jsxs)(n.p,{children:["When you call [create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter ",(0,t.jsx)(n.a,{href:"/TODO",children:(0,t.jsx)(n.code,{children:"ev"})}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\n\nev.on('event', callback)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The event you want to listen to is in the format of [namespace].[sessionId]"}),"\n",(0,t.jsx)(n.p,{children:"The event can include wildcards."}),"\n",(0,t.jsxs)(n.p,{children:["For example, to listen to all qr code events, the event will be ",(0,t.jsx)(n.code,{children:"qr.**"}),". e.g:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('qr.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all sessionData events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('sessionData.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events from session1"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.session1',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**', (data, sessionId, namespace) => {\n\n console.log(`${namespace} event detected for session ${sessionId}`, data)\n\n});\n"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>i});var t=s(6540);const a={},o=t.createContext(a);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18c41134.ab323e10.js b/assets/js/18c41134.ab323e10.js new file mode 100644 index 0000000000..2805d08453 --- /dev/null +++ b/assets/js/18c41134.ab323e10.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9262],{3849:(e,n,s)=>{s.r(n),s.d(n,{Highlight:()=>d,assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=s(4848),t=s(8453);const a={sidebar_position:4},o="Markdown Features",i={id:"tutorial-basics/markdown-features",title:"Markdown Features",description:"Docusaurus supports Markdown and a few additional features.",source:"@site/docs/tutorial-basics/markdown-features.mdx",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/markdown-features",permalink:"/docs/tutorial-basics/markdown-features",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/markdown-features.mdx",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Create a Blog Post",permalink:"/docs/tutorial-basics/create-a-blog-post"},next:{title:"Deploy your site",permalink:"/docs/tutorial-basics/deploy-your-site"}},c={},d=({children:e,color:n})=>{const s={span:"span",...(0,t.R)()};return(0,r.jsx)(s.span,{style:{backgroundColor:n,borderRadius:"20px",color:"#fff",padding:"10px",cursor:"pointer"},onClick:()=>{alert(`You clicked the color ${n} with label ${e}`)},children:e})},l=[{value:"Front Matter",id:"front-matter",level:2},{value:"Links",id:"links",level:2},{value:"Images",id:"images",level:2},{value:"Code Blocks",id:"code-blocks",level:2},{value:"Admonitions",id:"admonitions",level:2},{value:"MDX and React Components",id:"mdx-and-react-components",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"markdown-features",children:"Markdown Features"})}),"\n",(0,r.jsxs)(n.p,{children:["Docusaurus supports ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://daringfireball.net/projects/markdown/syntax",children:"Markdown"})})," and a few ",(0,r.jsx)(n.strong,{children:"additional features"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"front-matter",children:"Front Matter"}),"\n",(0,r.jsxs)(n.p,{children:["Markdown documents have metadata at the top called ",(0,r.jsx)(n.a,{href:"https://jekyllrb.com/docs/front-matter/",children:"Front Matter"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",metastring:'title="my-doc.md"',children:"// highlight-start\n---\nid: my-doc-id\ntitle: My document title\ndescription: My document description\nslug: /my-custom-url\n---\n// highlight-end\n\n## Markdown heading\n\nMarkdown text with [links](./hello.md)\n"})}),"\n",(0,r.jsx)(n.h2,{id:"links",children:"Links"}),"\n",(0,r.jsx)(n.p,{children:"Regular Markdown links are supported, using url paths or relative file paths."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"Let's see how to [Create a page](/create-a-page).\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"Let's see how to [Create a page](./create-a-page.md).\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Result:"})," Let's see how to ",(0,r.jsx)(n.a,{href:"/docs/tutorial-basics/create-a-page",children:"Create a page"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"images",children:"Images"}),"\n",(0,r.jsx)(n.p,{children:"Regular Markdown images are supported."}),"\n",(0,r.jsxs)(n.p,{children:["You can use absolute paths to reference images in the static directory (",(0,r.jsx)(n.code,{children:"static/img/docusaurus.png"}),"):"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"![Docusaurus logo](/img/docusaurus.png)\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{alt:"Docusaurus logo",src:s(625).A+"",width:"200",height:"200"})}),"\n",(0,r.jsx)(n.p,{children:"You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"![Docusaurus logo](./img/docusaurus.png)\n"})}),"\n",(0,r.jsx)(n.h2,{id:"code-blocks",children:"Code Blocks"}),"\n",(0,r.jsx)(n.p,{children:"Markdown code blocks are supported with Syntax highlighting."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:'```jsx title="src/components/HelloDocusaurus.js"\nfunction HelloDocusaurus() {\n return

Hello, Docusaurus!

;\n}\n```\n'})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",metastring:'title="src/components/HelloDocusaurus.js"',children:"function HelloDocusaurus() {\n return

Hello, Docusaurus!

;\n}\n"})}),"\n",(0,r.jsx)(n.h2,{id:"admonitions",children:"Admonitions"}),"\n",(0,r.jsx)(n.p,{children:"Docusaurus has a special syntax to create admonitions and callouts:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:":::tip[My tip]\n\nUse this awesome feature option\n\n:::\n\n:::danger[Take care]\n\nThis action is dangerous\n\n:::\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"My tip",type:"tip",children:(0,r.jsx)(n.p,{children:"Use this awesome feature option"})}),"\n",(0,r.jsx)(n.admonition,{title:"Take care",type:"danger",children:(0,r.jsx)(n.p,{children:"This action is dangerous"})}),"\n",(0,r.jsx)(n.h2,{id:"mdx-and-react-components",children:"MDX and React Components"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://mdxjs.com/",children:"MDX"})," can make your documentation more ",(0,r.jsx)(n.strong,{children:"interactive"})," and allows using any ",(0,r.jsx)(n.strong,{children:"React components inside Markdown"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",children:"export const Highlight = ({children, color}) => (\n {\n alert(`You clicked the color ${color} with label ${children}`)\n }}>\n {children}\n \n);\n\nThis is Docusaurus green !\n\nThis is Facebook blue !\n"})}),"\n","\n",(0,r.jsxs)(n.p,{children:["This is ",(0,r.jsx)(d,{color:"#25c2a0",children:"Docusaurus green"})," !"]}),"\n",(0,r.jsxs)(n.p,{children:["This is ",(0,r.jsx)(d,{color:"#1877F2",children:"Facebook blue"})," !"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},625:(e,n,s)=>{s.d(n,{A:()=>r});const r="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAT3UlEQVR42u1dCVQVV5pWXNt2N0czykl33KImZ7IgKgqIghq3KCDK+qowCek2c2K0Mx3idBxakzYxJnZiq3Gf6Bg7UdN2R51MxnTSia3gew9Rwccm7oqiiIK4sPxTt1hEHo9XvPVW1fed852Dr+67UNb/1f3/+9/731atAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAO8i2CxGjDUJXzMGmcSZnmoHAF7B6GMJvYPNwq5gk1AmMS/YJMbaahtkNsRLbeghmoU4d7cDAO+NCEbhQCMjrZbe5q81bhdyVOwuXbtqZdDSZ+yau9oBgNcgGeIvmzDQJkUy1ix8ZKMtsWvuagcAXsNYs/iyLSNlIgk2GebLQjKJQ6R/32+mbcWYI8KTrm6HJwR4170yCV80Y6T1I4kklH122lFNG9e2wxMC3Ao/U1KnQLPgF2SK/xeri5TiIxlikX1DBXVANpoXSy/DzGCjYfdYs2FRiFkcxWxEu/GF0RAm3fT1Bv8JJyV+LLlV08ccnNuFCQeGAdrheWkkXxaSGueruZFDurlrzfn4QSbDGRgAqJD3JK4NMcU8oo3RIz1hOB4q6AZeCzKK0aoXCIs58DBBt9Esfip5Ke3UPkN1Eg8TdB8N+5grr+JRxPAJHiLoTgaZhf97MiuqvVqTgNPxEEEPcK0qBTIyNa6rnWw1CLooJjHMUZc6KMWnNs9xDg8Q9ACLQtMMvbhfeFi7tuoLZMhBz1NczaUw2H4OFizhAYFe5l0uM+61m53wgMAWM+C7aBr425Ey2c8umPpdxmO+oxQPWz8cvnOmTGf7Gf1DDHXs25lYxMrIfmafOdnvOe4WONZsk4XhaD7nkJpAPQN96w2a/cw+c7S/QYsC6vuq46D/CHD+7zQaRvDmYsXVbG6CEWmZQ5YGWRk0+8zR/phb1bg/9pkLgvVk/twso+EViETbfPw1PyuDHrDQ36n4o6GL1eHRn7skDhlrEnZyuvbKMN/TIglKM9AzmyfLbzL2sBjZz89sniJfg2G7Nvbwad+m3qB9OrQh/z0RTschzK1yXZAu8zi/CxQ9NJL4fT6d+kwdQG27drB6q9WxXbcO1GfaAPL78wswcBfx6Y2T6ZHxv5DJfuY1acj5Kl55JHHPtOCBaOozZQC18mltUxhWlNoyobjwDQVyng/hVhyBaYbBrEKhW0aNL2Y85LO2lB37daHhX86AAemAPC4z6R5sEt9j6nWXONr8vJ3D4qhj287tIRIIxMP7PmrKd151p1vV3MjRtmt7eiT0F+QbN4z6xQ6T/eO2XdrbbP8z3y5wtyAQT+VAxAh336wcczQVhPfsKM+ANJWsYp+xRFS7Hh2b/C6LSWBIEIgnsuh73T1b1VRA3ql/dxq5d5bd74/4OlJu21TgjtktCMT9uwbdFJDXjx5TBzQ5cigRR71I/hZJ7bpbTwf3mT4QxgSBuHtbrSHcnUlAlstwxXqdgcmjmsyTIJkIgag2SGcZ8qYCckcWyAUdTpBnsBr398yWKTAoCESd07xD3rFeHMdmqxztj81uNe5v6B+CYVAQiAeD9qPiIOkP/NIVN9l//nArg/ZNeNLh/nzjn7Tqr//rw2FQEIg6M+lN7RcY/LvR3PQHupdh6S9R+LH5ZMh8i17NfoeS81bSO6fX0cfn/ps2X/wL7bzyv/TNtYP0z5KjdLw0hwrKL1DR/Rt0r+q+Plys0d/HyMtDGib4nNlx5ur+QPcZuLPQTSa9bjk0oyuM2dX9adm4Zx57jeIzk+lXliX0Ru4KSjm1hlac/S/69MKXtP3yXvrr1b/Td8WplHbzOGWV5dPZO5fo+v0Slxi4ZgTiiUw66BoD/32BPQO/zI2Ba0cgbs6kg9aMPfFbWn5mM/258H80a+CaEYi7M+ngA7JR4ERpHgFqEogbM+lgDSelv0LfFx+B1SNIBxtzWsarlH27ABavZoF4YsOUHhliEuX4AlCOwsJC2rVrF7+JwjHGuU8Em4X9MHDn+afzOzRtzGVlZbR69WqKjY2lqKgoev/996m4uNihvqqrqyklJYU6dKhf3Kq/Pel6izuKK246bYQXLlygvXv30ldffUWZmZlO9cX6CAwMpI4dO1Lbtm3pueeeo61btzrUV1ZWFj3++ONWKxseffRRMpvNLe7vzTffrClF5ONDEydOhIuldb53ZqNTxpyfn08RERFWBsiM2mQytbi/+fPn29zCnJSU1KK+ioqKyNe3poTpU089RRs3bqTt27dTQEBAvUiuXr2quL8ff/xRFgYT7e7duxGk64E/FBsdFsfhw4epR48eNTsvO3WioKAgmjRpEvXu3Vv+rHPnzvTTTz8p7u/dd9+tqXwouS/Lly+nS5cuUUlJCa1fv17ui11j7pFSTJs2Tf4O+7tu3bpV//ndu3fr3v40Y8YMRX1VVFTQkCFD5O8sW7YMmXS98MLdQofEYbFYqFu3brLBsBGEBa11KC0tpcTERPkaa8NGGXs4ePCg/HZu06YN7du3z+r6/v3769/e6enpdvvbs2dPTeHrnj1l968xLl68SN2712yR/vbbb+3299lnn8ltn3jiCbp37x4y6XphedWdFouDBbiDBw+WDWb27NlUWVlp1aaqqooiIyPlNsOHD3/IqBrj9u3bNGjQILnt4sWLbbZbuHCh3Mbf37/J31kH9rvq+mPBuS2w0Yi18fPzk4NvW2C/iwmDtd22bRsy6RAINWvM48aNq48z2L9tgblH/fv3l9suWLDAZrt58+bJbZ5++ulmhcRGpscee8yu4a9YsUJuM2zYMNk1soXy8nLq16+f3Hbnzp0227EJAtZm4MCBVv0hkw4XS8aNGzdkV4S9bZmxMMM6f/683e+lpaVR+/Y1W5A//PBDq+vr1q2Tr7E2GRkZil2nrl27Um5ubpOTBuwaa/PNN9/Y7a/u97MRgsUmjcE+Y8JgbbZs2YJMut6oZGnJ6NGjHz5bQzKYggLlWXf2BmbxA/suC+LZbNKOHTsoLi6OWrduLXPz5s2K+2P5DNYXC5rz8h6sGbt8+bI8qrFrrI3S4JuNNOw7ycnJVtfffvvtZkcjTPNqnMtOb7BrRGPGjJFnlpiRfPDBB826VbbABNGrVy/rii/t2tGqVata7OY9++yz8ve7dOkiC41NAdfNng0dOlR2x5TCaDTKfwf77tKlS2UhsJiEuXFs0oCJ+9ChQ+pYauKOPel65sT0JJckCpXmJVhgzLLZM2fOpEWLFj00ArR0oqCp/AuLj9hI0lIwkbKRrG7mqy42YVyyZIl61mJhqYnruercdtUuI2HTzZs2baK1a9fSkSPOrURm8U1droOxb9++tGHDBixWxGJFkVJLjmEFYoMcCYuxmpsBQ5Cuu+Xu8+hk2SmoQ63L3ZFJ90w8cuD6YVi9KgWCTLrHuDB3uVwep5qqoQC1CASZdM8z+sQb9P6ZTbSjcD+KNnAvEGTSUfYHAkGQDoGhcBymeUGUHkUmHdS6wG5VlmFPOgjq/gAdEMQRbCCoZYEgkw5CIMikgxAIMukgBIJMOgiBIEgHIRBM84KgegSCTDoIgSCTzvcWXbNAv7bE0/oL0fSPG1F0+k4k3aoMp4rqmUSkL8LFAus563gCbb88h4ruR+hOCKoQCIJ07/CFDAP9rWg23a+GILgVCDLp3uGSghi6WREOMXAvEGTSPcrxUpzxtTRqQAQqEQgCck9WNzFQasksCEBVAkEm3WMjB8SBIB20QbhVmOYFbXBpQazLDYjlR25XhetGIJOyXuw5JntuF2TSNVd61EAlLpytqpa4sjCWJmSLMtdcidG2QKhV67CcxHVh2WJVLVcik65zjmVZ9QyRxmcKFHpSJMkoaGqOSHGnDPTGuXj53w1pLIvSnECk+yoPzRZPh2Un/r3x/YZZEifBxdLrcpOMB6JQyt3Fc7QokOb4OoJ0vdEs0LgTLRNGHQ/cnE07JZEcLo2SXTCtC2RCdmJ8aI64MNSSOI25YMik64COiqMxPy6M0cMI0oDCGmTSdeBWuUIcYbWBe6kGZrdacM/VIafF7sikazggb2nMYU8gJZURehJIVUhO0iPIpGt29HCdOBj/qDMXS3ohfIogXctLUDJd516xaeCvb8yhMv24WGekQP2VsFNJ3TDNq1G60r2qY4IkFLWLpIX3fMojIkEm3QsV0LMFlwuEcfS/P0N+ft29ypdf/qWnBEJhFiEJmXQIRDH7RQ2uP5fcW+zbt6PHBDIhJ/EluFhwsRRxzsl4OmgeTyZTiFdZXDzVUwLJd6uLhSBdO0H63huzdRWkM9fKreJAJl07SULGjy7H6iuTbhHXI5Ou8URhGBKFHCcKEZB7fxQ5iqUm/C41QSadk8WKrhHJJ4X6crFCLeKfkEnXiavl7HL31LJZutgPUrfcPSxXmIoNU3rcMGURsGGKpw1TyKTzKZTxmWJtnkT6OSOBxhyYRX6fPW9lML0C+3k9KdgUR47s4dSWW4kF3Gy5RSbdtXTUMEaM6NG84bVuRUNSAiThSCNNlkCDk/25FAfjqFE9XVO0IVtcW1uwoTLMInyEsj86FohSllaGU7mOyv5MPR7bIyRrXmcUjoNAQFR3h0BAVHeHQEBUdwchEFR3ByEQVHdHkA6BQCCY5oVAIBBk0tUrEH//Htwm/jyZSedWIMikc55JVxFdkkmHiwWBgAjSIRAQmXQQAkEmHYRAkEkHeRDIP0ujaOG5eJqWK8j8jfQzOyQHAkEmXfcC2XA12uaOuk1F0RAIgnRtC4Qd4XyifBZZ7kRaHefMRg5722wbjySsD9YX61MLx0OH5cwNnJwX1xXTvDoTyF3JeD8pjKHncx4Y+xTp51VXYuRrrM3CJk6ybUx22u2D/mLlPuquTc4RavqrVv2e9LthOcKqgPNRP0MmXQcCqZAMdsFZ28b/unTNf1QvGpceZ1cg48xx5NPOh4Z/PsVmG79tz1Prtj5q3ZPekD/4mZLaIZOu9dpXx+1XKBl3XFlFk9BMAw1+a4Tddo8Zhqkyk95EQbz5cLG0Xsk9S3TLUQfN8ddnErRS9seMIF3rZ4FYPC+QF3IFrQjkFjLpOAvE5UwsMGhFIBZk0rV+FsgJweMC+Vilp95a34uwBpl0rdffNXtWIKzS+9Hbs2hlYSwZThnkqWA2onx+LZr7KeDGFdxDsw3jwnIS18mnSWWLd9iIEmpJfMvtU8DIpHtwBMny/Ahii/8mBe88JxRb8BJIc3tCEUG6Nt0re/zgcozqBVLrfm3GNK+aC1Ef408cjBM5Po2qhfdS6dZTppBJd2/cEWoRuRQIY8/RfdWQSbfP3LlhSoPuxSGpcb7IpMO1UsIe/n1UkUm3OxrmCsF2jTs09aU+0kO5zQwcLhYHTBe5Fgdb1HirMlwLLtbdSVkv9lSS01ha93CCzMpP4UGQzve5g+7iHzk+z7CF97JWadIvr8EDqmJZcmTSvUSzd5aWKOX8swn1y+tVLpCD001JnezHHkdE/yYe1B17IkEm3U3BeTq/o8faK9Hy0nvVn3JrET5SvAxeeii/sfGwqqSY5DVk0j3sXh3jd/Rgm7V43+Ou8F7uSyyT+P1EizjdnkC+sDPk7x+TPrcvMukemr3K5DtA532PuyP3EZojvtvc9G6mggd3LcgoLAg49PD6FQTp7li5K6hGIE3tcVejQGSRWBKn2RpBLrXgAbK2vws0zu2PaV7t7P1whnV73NUuEHZstC2B3HFwtuVIkEn8cKxRiJFGkn8NyZgbGGw07IaROzmCZKtLIGyPu6oz6fY2VkkP5R4MEwJxlCGmOG4y6ferw525l5u2BHIdhsmRQOBiOUy2gNLhGCRb/M6ZIB3U8PZaZ5haNosbgRTcjXT8XnKFqbZGkK9gmDxtjlKPOLZwNs37j1uzHbwXYWlzOwMXwTCRKFSaKJyeK8huFU8jh5K6xNaJQqGUuVU2R476aVqzOAqGiaUmSnjmXiTXy0xePZOgLN7ISxymfL06pfhID+YcjJMTgXAah7xymu9CclfuR8jFJhTcy1EHSvgYlsE41VVq1NPccX0O1wJhFVcU3UuOmNzyfeWpcb7Ih/C1YYqnfAirsnijkt8l7iz/EZ1vUJQMnJif0NvRQnBrYZw8bZriRyDbrvE9euwpnqOs1E+OsNjhogsBh17sKT2YIhgnLxunRC7WZc3OF6ic4w1SN6WRLTJP0ehxOSRrXmfn6lwZxWgYJ8r+NKywmMbhdG5DLrkYp+ReqsbnGCa7qij1pzBOVDdh3HqN7zMN/3pjttLA/D9dVt8q6suoNmNNwl9gnPreRPV76c1czbE4WKJyUo6il8euFErxcWkROD9TUqdgk2EfjJOf3IgnRfLepViqrOY37mCbtKbmKhLH1pDvU9q6pVIi29SOmS19zWxNqC3MUM25W6Vg5KhmhRlaUavWHjgoxzAHs1scBe4ZclUOl4sjJt9AxrIoboVRUhmuNCA/F2ZJnOTRs0BC0wy9gk3iamyr5ad2lquCd1alZM2VGG6PNGBJQJbnCM+ze7+sSslKr56RPj7D0K92WQrWbnEiFLYsxZG1W2zEYMszeC0herUiQv77FGTIz7EDcRSVEPUYKMUnyGgYIY0qyVIAuVN6WMdrdyZiuYqXgvixRwX5KOjxmTWLHdnORLZchfnrEdLb9+XTCZKLEiv78GfvRXA0QsykmxXhlF8eST8UR9G6i9H0q7x4Cm10H2HZQoUkhmsSj0/IFnZOyBFeDctNGNoKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAsI3/BxVeQNnL1kBuAAAAAElFTkSuQmCC"},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var r=s(6540);const t={},a=r.createContext(t);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18c41134.c0e68903.js b/assets/js/18c41134.c0e68903.js deleted file mode 100644 index bfe6ea3e17..0000000000 --- a/assets/js/18c41134.c0e68903.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9262],{3849:(e,n,s)=>{s.r(n),s.d(n,{Highlight:()=>l,assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var r=s(4848),t=s(8453);const a={sidebar_position:4},o="Markdown Features",i={id:"tutorial-basics/markdown-features",title:"Markdown Features",description:"Docusaurus supports Markdown and a few additional features.",source:"@site/docs/tutorial-basics/markdown-features.mdx",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/markdown-features",permalink:"/docs/tutorial-basics/markdown-features",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/markdown-features.mdx",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Create a Blog Post",permalink:"/docs/tutorial-basics/create-a-blog-post"},next:{title:"Deploy your site",permalink:"/docs/tutorial-basics/deploy-your-site"}},c={},l=({children:e,color:n})=>{const s={span:"span",...(0,t.R)()};return(0,r.jsx)(s.span,{style:{backgroundColor:n,borderRadius:"20px",color:"#fff",padding:"10px",cursor:"pointer"},onClick:()=>{alert(`You clicked the color ${n} with label ${e}`)},children:e})},d=[{value:"Front Matter",id:"front-matter",level:2},{value:"Links",id:"links",level:2},{value:"Images",id:"images",level:2},{value:"Code Blocks",id:"code-blocks",level:2},{value:"Admonitions",id:"admonitions",level:2},{value:"MDX and React Components",id:"mdx-and-react-components",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",img:"img",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"markdown-features",children:"Markdown Features"}),"\n",(0,r.jsxs)(n.p,{children:["Docusaurus supports ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://daringfireball.net/projects/markdown/syntax",children:"Markdown"})})," and a few ",(0,r.jsx)(n.strong,{children:"additional features"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"front-matter",children:"Front Matter"}),"\n",(0,r.jsxs)(n.p,{children:["Markdown documents have metadata at the top called ",(0,r.jsx)(n.a,{href:"https://jekyllrb.com/docs/front-matter/",children:"Front Matter"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",metastring:'title="my-doc.md"',children:"// highlight-start\n---\nid: my-doc-id\ntitle: My document title\ndescription: My document description\nslug: /my-custom-url\n---\n// highlight-end\n\n## Markdown heading\n\nMarkdown text with [links](./hello.md)\n"})}),"\n",(0,r.jsx)(n.h2,{id:"links",children:"Links"}),"\n",(0,r.jsx)(n.p,{children:"Regular Markdown links are supported, using url paths or relative file paths."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"Let's see how to [Create a page](/create-a-page).\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"Let's see how to [Create a page](./create-a-page.md).\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Result:"})," Let's see how to ",(0,r.jsx)(n.a,{href:"/docs/tutorial-basics/create-a-page",children:"Create a page"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"images",children:"Images"}),"\n",(0,r.jsx)(n.p,{children:"Regular Markdown images are supported."}),"\n",(0,r.jsxs)(n.p,{children:["You can use absolute paths to reference images in the static directory (",(0,r.jsx)(n.code,{children:"static/img/docusaurus.png"}),"):"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"![Docusaurus logo](/img/docusaurus.png)\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{alt:"Docusaurus logo",src:s(625).A+"",width:"200",height:"200"})}),"\n",(0,r.jsx)(n.p,{children:"You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:"![Docusaurus logo](./img/docusaurus.png)\n"})}),"\n",(0,r.jsx)(n.h2,{id:"code-blocks",children:"Code Blocks"}),"\n",(0,r.jsx)(n.p,{children:"Markdown code blocks are supported with Syntax highlighting."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:'```jsx title="src/components/HelloDocusaurus.js"\nfunction HelloDocusaurus() {\n return

Hello, Docusaurus!

;\n}\n```\n'})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",metastring:'title="src/components/HelloDocusaurus.js"',children:"function HelloDocusaurus() {\n return

Hello, Docusaurus!

;\n}\n"})}),"\n",(0,r.jsx)(n.h2,{id:"admonitions",children:"Admonitions"}),"\n",(0,r.jsx)(n.p,{children:"Docusaurus has a special syntax to create admonitions and callouts:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-md",children:":::tip[My tip]\n\nUse this awesome feature option\n\n:::\n\n:::danger[Take care]\n\nThis action is dangerous\n\n:::\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"My tip",type:"tip",children:(0,r.jsx)(n.p,{children:"Use this awesome feature option"})}),"\n",(0,r.jsx)(n.admonition,{title:"Take care",type:"danger",children:(0,r.jsx)(n.p,{children:"This action is dangerous"})}),"\n",(0,r.jsx)(n.h2,{id:"mdx-and-react-components",children:"MDX and React Components"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://mdxjs.com/",children:"MDX"})," can make your documentation more ",(0,r.jsx)(n.strong,{children:"interactive"})," and allows using any ",(0,r.jsx)(n.strong,{children:"React components inside Markdown"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",children:"export const Highlight = ({children, color}) => (\n {\n alert(`You clicked the color ${color} with label ${children}`)\n }}>\n {children}\n \n);\n\nThis is Docusaurus green !\n\nThis is Facebook blue !\n"})}),"\n","\n",(0,r.jsxs)(n.p,{children:["This is ",(0,r.jsx)(l,{color:"#25c2a0",children:"Docusaurus green"})," !"]}),"\n",(0,r.jsxs)(n.p,{children:["This is ",(0,r.jsx)(l,{color:"#1877F2",children:"Facebook blue"})," !"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},625:(e,n,s)=>{s.d(n,{A:()=>r});const r="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAT3UlEQVR42u1dCVQVV5pWXNt2N0czykl33KImZ7IgKgqIghq3KCDK+qowCek2c2K0Mx3idBxakzYxJnZiq3Gf6Bg7UdN2R51MxnTSia3gew9Rwccm7oqiiIK4sPxTt1hEHo9XvPVW1fed852Dr+67UNb/1f3/+9/731atAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAO8i2CxGjDUJXzMGmcSZnmoHAF7B6GMJvYPNwq5gk1AmMS/YJMbaahtkNsRLbeghmoU4d7cDAO+NCEbhQCMjrZbe5q81bhdyVOwuXbtqZdDSZ+yau9oBgNcgGeIvmzDQJkUy1ix8ZKMtsWvuagcAXsNYs/iyLSNlIgk2GebLQjKJQ6R/32+mbcWYI8KTrm6HJwR4170yCV80Y6T1I4kklH122lFNG9e2wxMC3Ao/U1KnQLPgF2SK/xeri5TiIxlikX1DBXVANpoXSy/DzGCjYfdYs2FRiFkcxWxEu/GF0RAm3fT1Bv8JJyV+LLlV08ccnNuFCQeGAdrheWkkXxaSGueruZFDurlrzfn4QSbDGRgAqJD3JK4NMcU8oo3RIz1hOB4q6AZeCzKK0aoXCIs58DBBt9Esfip5Ke3UPkN1Eg8TdB8N+5grr+JRxPAJHiLoTgaZhf97MiuqvVqTgNPxEEEPcK0qBTIyNa6rnWw1CLooJjHMUZc6KMWnNs9xDg8Q9ACLQtMMvbhfeFi7tuoLZMhBz1NczaUw2H4OFizhAYFe5l0uM+61m53wgMAWM+C7aBr425Ey2c8umPpdxmO+oxQPWz8cvnOmTGf7Gf1DDHXs25lYxMrIfmafOdnvOe4WONZsk4XhaD7nkJpAPQN96w2a/cw+c7S/QYsC6vuq46D/CHD+7zQaRvDmYsXVbG6CEWmZQ5YGWRk0+8zR/phb1bg/9pkLgvVk/twso+EViETbfPw1PyuDHrDQ36n4o6GL1eHRn7skDhlrEnZyuvbKMN/TIglKM9AzmyfLbzL2sBjZz89sniJfg2G7Nvbwad+m3qB9OrQh/z0RTschzK1yXZAu8zi/CxQ9NJL4fT6d+kwdQG27drB6q9WxXbcO1GfaAPL78wswcBfx6Y2T6ZHxv5DJfuY1acj5Kl55JHHPtOCBaOozZQC18mltUxhWlNoyobjwDQVyng/hVhyBaYbBrEKhW0aNL2Y85LO2lB37daHhX86AAemAPC4z6R5sEt9j6nWXONr8vJ3D4qhj287tIRIIxMP7PmrKd151p1vV3MjRtmt7eiT0F+QbN4z6xQ6T/eO2XdrbbP8z3y5wtyAQT+VAxAh336wcczQVhPfsKM+ANJWsYp+xRFS7Hh2b/C6LSWBIEIgnsuh73T1b1VRA3ql/dxq5d5bd74/4OlJu21TgjtktCMT9uwbdFJDXjx5TBzQ5cigRR71I/hZJ7bpbTwf3mT4QxgSBuHtbrSHcnUlAlstwxXqdgcmjmsyTIJkIgag2SGcZ8qYCckcWyAUdTpBnsBr398yWKTAoCESd07xD3rFeHMdmqxztj81uNe5v6B+CYVAQiAeD9qPiIOkP/NIVN9l//nArg/ZNeNLh/nzjn7Tqr//rw2FQEIg6M+lN7RcY/LvR3PQHupdh6S9R+LH5ZMh8i17NfoeS81bSO6fX0cfn/ps2X/wL7bzyv/TNtYP0z5KjdLw0hwrKL1DR/Rt0r+q+Plys0d/HyMtDGib4nNlx5ur+QPcZuLPQTSa9bjk0oyuM2dX9adm4Zx57jeIzk+lXliX0Ru4KSjm1hlac/S/69MKXtP3yXvrr1b/Td8WplHbzOGWV5dPZO5fo+v0Slxi4ZgTiiUw66BoD/32BPQO/zI2Ba0cgbs6kg9aMPfFbWn5mM/258H80a+CaEYi7M+ngA7JR4ERpHgFqEogbM+lgDSelv0LfFx+B1SNIBxtzWsarlH27ABavZoF4YsOUHhliEuX4AlCOwsJC2rVrF7+JwjHGuU8Em4X9MHDn+afzOzRtzGVlZbR69WqKjY2lqKgoev/996m4uNihvqqrqyklJYU6dKhf3Kq/Pel6izuKK246bYQXLlygvXv30ldffUWZmZlO9cX6CAwMpI4dO1Lbtm3pueeeo61btzrUV1ZWFj3++ONWKxseffRRMpvNLe7vzTffrClF5ONDEydOhIuldb53ZqNTxpyfn08RERFWBsiM2mQytbi/+fPn29zCnJSU1KK+ioqKyNe3poTpU089RRs3bqTt27dTQEBAvUiuXr2quL8ff/xRFgYT7e7duxGk64E/FBsdFsfhw4epR48eNTsvO3WioKAgmjRpEvXu3Vv+rHPnzvTTTz8p7u/dd9+tqXwouS/Lly+nS5cuUUlJCa1fv17ui11j7pFSTJs2Tf4O+7tu3bpV//ndu3fr3v40Y8YMRX1VVFTQkCFD5O8sW7YMmXS98MLdQofEYbFYqFu3brLBsBGEBa11KC0tpcTERPkaa8NGGXs4ePCg/HZu06YN7du3z+r6/v3769/e6enpdvvbs2dPTeHrnj1l968xLl68SN2712yR/vbbb+3299lnn8ltn3jiCbp37x4y6XphedWdFouDBbiDBw+WDWb27NlUWVlp1aaqqooiIyPlNsOHD3/IqBrj9u3bNGjQILnt4sWLbbZbuHCh3Mbf37/J31kH9rvq+mPBuS2w0Yi18fPzk4NvW2C/iwmDtd22bRsy6RAINWvM48aNq48z2L9tgblH/fv3l9suWLDAZrt58+bJbZ5++ulmhcRGpscee8yu4a9YsUJuM2zYMNk1soXy8nLq16+f3Hbnzp0227EJAtZm4MCBVv0hkw4XS8aNGzdkV4S9bZmxMMM6f/683e+lpaVR+/Y1W5A//PBDq+vr1q2Tr7E2GRkZil2nrl27Um5ubpOTBuwaa/PNN9/Y7a/u97MRgsUmjcE+Y8JgbbZs2YJMut6oZGnJ6NGjHz5bQzKYggLlWXf2BmbxA/suC+LZbNKOHTsoLi6OWrduLXPz5s2K+2P5DNYXC5rz8h6sGbt8+bI8qrFrrI3S4JuNNOw7ycnJVtfffvvtZkcjTPNqnMtOb7BrRGPGjJFnlpiRfPDBB826VbbABNGrVy/rii/t2tGqVata7OY9++yz8ve7dOkiC41NAdfNng0dOlR2x5TCaDTKfwf77tKlS2UhsJiEuXFs0oCJ+9ChQ+pYauKOPel65sT0JJckCpXmJVhgzLLZM2fOpEWLFj00ArR0oqCp/AuLj9hI0lIwkbKRrG7mqy42YVyyZIl61mJhqYnruercdtUuI2HTzZs2baK1a9fSkSPOrURm8U1droOxb9++tGHDBixWxGJFkVJLjmEFYoMcCYuxmpsBQ5Cuu+Xu8+hk2SmoQ63L3ZFJ90w8cuD6YVi9KgWCTLrHuDB3uVwep5qqoQC1CASZdM8z+sQb9P6ZTbSjcD+KNnAvEGTSUfYHAkGQDoGhcBymeUGUHkUmHdS6wG5VlmFPOgjq/gAdEMQRbCCoZYEgkw5CIMikgxAIMukgBIJMOgiBIEgHIRBM84KgegSCTDoIgSCTzvcWXbNAv7bE0/oL0fSPG1F0+k4k3aoMp4rqmUSkL8LFAus563gCbb88h4ruR+hOCKoQCIJ07/CFDAP9rWg23a+GILgVCDLp3uGSghi6WREOMXAvEGTSPcrxUpzxtTRqQAQqEQgCck9WNzFQasksCEBVAkEm3WMjB8SBIB20QbhVmOYFbXBpQazLDYjlR25XhetGIJOyXuw5JntuF2TSNVd61EAlLpytqpa4sjCWJmSLMtdcidG2QKhV67CcxHVh2WJVLVcik65zjmVZ9QyRxmcKFHpSJMkoaGqOSHGnDPTGuXj53w1pLIvSnECk+yoPzRZPh2Un/r3x/YZZEifBxdLrcpOMB6JQyt3Fc7QokOb4OoJ0vdEs0LgTLRNGHQ/cnE07JZEcLo2SXTCtC2RCdmJ8aI64MNSSOI25YMik64COiqMxPy6M0cMI0oDCGmTSdeBWuUIcYbWBe6kGZrdacM/VIafF7sikazggb2nMYU8gJZURehJIVUhO0iPIpGt29HCdOBj/qDMXS3ohfIogXctLUDJd516xaeCvb8yhMv24WGekQP2VsFNJ3TDNq1G60r2qY4IkFLWLpIX3fMojIkEm3QsV0LMFlwuEcfS/P0N+ft29ypdf/qWnBEJhFiEJmXQIRDH7RQ2uP5fcW+zbt6PHBDIhJ/EluFhwsRRxzsl4OmgeTyZTiFdZXDzVUwLJd6uLhSBdO0H63huzdRWkM9fKreJAJl07SULGjy7H6iuTbhHXI5Ou8URhGBKFHCcKEZB7fxQ5iqUm/C41QSadk8WKrhHJJ4X6crFCLeKfkEnXiavl7HL31LJZutgPUrfcPSxXmIoNU3rcMGURsGGKpw1TyKTzKZTxmWJtnkT6OSOBxhyYRX6fPW9lML0C+3k9KdgUR47s4dSWW4kF3Gy5RSbdtXTUMEaM6NG84bVuRUNSAiThSCNNlkCDk/25FAfjqFE9XVO0IVtcW1uwoTLMInyEsj86FohSllaGU7mOyv5MPR7bIyRrXmcUjoNAQFR3h0BAVHeHQEBUdwchEFR3ByEQVHdHkA6BQCCY5oVAIBBk0tUrEH//Htwm/jyZSedWIMikc55JVxFdkkmHiwWBgAjSIRAQmXQQAkEmHYRAkEkHeRDIP0ujaOG5eJqWK8j8jfQzOyQHAkEmXfcC2XA12uaOuk1F0RAIgnRtC4Qd4XyifBZZ7kRaHefMRg5722wbjySsD9YX61MLx0OH5cwNnJwX1xXTvDoTyF3JeD8pjKHncx4Y+xTp51VXYuRrrM3CJk6ybUx22u2D/mLlPuquTc4RavqrVv2e9LthOcKqgPNRP0MmXQcCqZAMdsFZ28b/unTNf1QvGpceZ1cg48xx5NPOh4Z/PsVmG79tz1Prtj5q3ZPekD/4mZLaIZOu9dpXx+1XKBl3XFlFk9BMAw1+a4Tddo8Zhqkyk95EQbz5cLG0Xsk9S3TLUQfN8ddnErRS9seMIF3rZ4FYPC+QF3IFrQjkFjLpOAvE5UwsMGhFIBZk0rV+FsgJweMC+Vilp95a34uwBpl0rdffNXtWIKzS+9Hbs2hlYSwZThnkqWA2onx+LZr7KeDGFdxDsw3jwnIS18mnSWWLd9iIEmpJfMvtU8DIpHtwBMny/Ahii/8mBe88JxRb8BJIc3tCEUG6Nt0re/zgcozqBVLrfm3GNK+aC1Ef408cjBM5Po2qhfdS6dZTppBJd2/cEWoRuRQIY8/RfdWQSbfP3LlhSoPuxSGpcb7IpMO1UsIe/n1UkUm3OxrmCsF2jTs09aU+0kO5zQwcLhYHTBe5Fgdb1HirMlwLLtbdSVkv9lSS01ha93CCzMpP4UGQzve5g+7iHzk+z7CF97JWadIvr8EDqmJZcmTSvUSzd5aWKOX8swn1y+tVLpCD001JnezHHkdE/yYe1B17IkEm3U3BeTq/o8faK9Hy0nvVn3JrET5SvAxeeii/sfGwqqSY5DVk0j3sXh3jd/Rgm7V43+Ou8F7uSyyT+P1EizjdnkC+sDPk7x+TPrcvMukemr3K5DtA532PuyP3EZojvtvc9G6mggd3LcgoLAg49PD6FQTp7li5K6hGIE3tcVejQGSRWBKn2RpBLrXgAbK2vws0zu2PaV7t7P1whnV73NUuEHZstC2B3HFwtuVIkEn8cKxRiJFGkn8NyZgbGGw07IaROzmCZKtLIGyPu6oz6fY2VkkP5R4MEwJxlCGmOG4y6ferw525l5u2BHIdhsmRQOBiOUy2gNLhGCRb/M6ZIB3U8PZaZ5haNosbgRTcjXT8XnKFqbZGkK9gmDxtjlKPOLZwNs37j1uzHbwXYWlzOwMXwTCRKFSaKJyeK8huFU8jh5K6xNaJQqGUuVU2R476aVqzOAqGiaUmSnjmXiTXy0xePZOgLN7ISxymfL06pfhID+YcjJMTgXAah7xymu9CclfuR8jFJhTcy1EHSvgYlsE41VVq1NPccX0O1wJhFVcU3UuOmNzyfeWpcb7Ih/C1YYqnfAirsnijkt8l7iz/EZ1vUJQMnJif0NvRQnBrYZw8bZriRyDbrvE9euwpnqOs1E+OsNjhogsBh17sKT2YIhgnLxunRC7WZc3OF6ic4w1SN6WRLTJP0ehxOSRrXmfn6lwZxWgYJ8r+NKywmMbhdG5DLrkYp+ReqsbnGCa7qij1pzBOVDdh3HqN7zMN/3pjttLA/D9dVt8q6suoNmNNwl9gnPreRPV76c1czbE4WKJyUo6il8euFErxcWkROD9TUqdgk2EfjJOf3IgnRfLepViqrOY37mCbtKbmKhLH1pDvU9q6pVIi29SOmS19zWxNqC3MUM25W6Vg5KhmhRlaUavWHjgoxzAHs1scBe4ZclUOl4sjJt9AxrIoboVRUhmuNCA/F2ZJnOTRs0BC0wy9gk3iamyr5ad2lquCd1alZM2VGG6PNGBJQJbnCM+ze7+sSslKr56RPj7D0K92WQrWbnEiFLYsxZG1W2zEYMszeC0herUiQv77FGTIz7EDcRSVEPUYKMUnyGgYIY0qyVIAuVN6WMdrdyZiuYqXgvixRwX5KOjxmTWLHdnORLZchfnrEdLb9+XTCZKLEiv78GfvRXA0QsykmxXhlF8eST8UR9G6i9H0q7x4Cm10H2HZQoUkhmsSj0/IFnZOyBFeDctNGNoKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAsI3/BxVeQNnL1kBuAAAAAElFTkSuQmCC"},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var r=s(6540);const t={},a=r.createContext(t);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a3c9b31.2c91aef5.js b/assets/js/1a3c9b31.2c91aef5.js deleted file mode 100644 index eff8a4b087..0000000000 --- a/assets/js/1a3c9b31.2c91aef5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9242],{1307:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var c=n(4848),s=n(8453);const i={},l="@open-wa/wa-automate v4.72.3",o={id:"reference/index",title:"@open-wa/wa-automate v4.72.3",description:"Modules",source:"@site/docs/reference/index.md",sourceDirName:"reference",slug:"/reference/",permalink:"/docs/reference/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"},next:{title:"api/Client",permalink:"/docs/reference/api/Client/"}},d={},a=[{value:"Modules",id:"modules",level:2}];function t(e){const r={a:"a",h1:"h1",h2:"h2",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.h1,{id:"open-wawa-automate-v4723",children:"@open-wa/wa-automate v4.72.3"}),"\n",(0,c.jsx)(r.h2,{id:"modules",children:"Modules"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/Client/",children:"api/Client"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/functions/exposed.enum/",children:"api/functions/exposed.enum"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/",children:"api/model"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/aliases/",children:"api/model/aliases"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/button/",children:"api/model/button"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/call/",children:"api/model/call"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/chat/",children:"api/model/chat"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/config/",children:"api/model/config"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/contact/",children:"api/model/contact"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/errors/",children:"api/model/errors"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/events/",children:"api/model/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/group-metadata/",children:"api/model/group-metadata"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/id/",children:"api/model/id"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/label/",children:"api/model/label"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/media/",children:"api/model/media"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/message/",children:"api/model/message"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/product/",children:"api/model/product"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/reactions/",children:"api/model/reactions"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/sessionInfo/",children:"api/model/sessionInfo"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/events/",children:"controllers/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/init_patch/",children:"controllers/init_patch"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/initializer/",children:"controllers/initializer"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/patch_manager/",children:"controllers/patch_manager"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/custom_transport/",children:"logging/custom_transport"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/logging/",children:"logging/logging"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Collector/",children:"structures/Collector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Dialog/",children:"structures/Dialog"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/MessageCollector/",children:"structures/MessageCollector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/preProcessors/",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(t,{...e})}):t(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var c=n(6540);const s={},i=c.createContext(s);function l(e){const r=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),c.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a3c9b31.a407983b.js b/assets/js/1a3c9b31.a407983b.js new file mode 100644 index 0000000000..73bb9388e8 --- /dev/null +++ b/assets/js/1a3c9b31.a407983b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9242],{1307:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var c=n(4848),s=n(8453);const i={},l="@open-wa/wa-automate v4.72.4",o={id:"reference/index",title:"@open-wa/wa-automate v4.72.4",description:"Modules",source:"@site/docs/reference/index.md",sourceDirName:"reference",slug:"/reference/",permalink:"/docs/reference/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"},next:{title:"api/Client",permalink:"/docs/reference/api/Client/"}},d={},a=[{value:"Modules",id:"modules",level:2}];function t(e){const r={a:"a",h1:"h1",h2:"h2",header:"header",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.header,{children:(0,c.jsx)(r.h1,{id:"open-wawa-automate-v4724",children:"@open-wa/wa-automate v4.72.4"})}),"\n",(0,c.jsx)(r.h2,{id:"modules",children:"Modules"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/Client/",children:"api/Client"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/functions/exposed.enum/",children:"api/functions/exposed.enum"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/",children:"api/model"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/aliases/",children:"api/model/aliases"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/button/",children:"api/model/button"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/call/",children:"api/model/call"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/chat/",children:"api/model/chat"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/config/",children:"api/model/config"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/contact/",children:"api/model/contact"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/errors/",children:"api/model/errors"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/events/",children:"api/model/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/group-metadata/",children:"api/model/group-metadata"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/id/",children:"api/model/id"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/label/",children:"api/model/label"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/media/",children:"api/model/media"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/message/",children:"api/model/message"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/product/",children:"api/model/product"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/reactions/",children:"api/model/reactions"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/sessionInfo/",children:"api/model/sessionInfo"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/events/",children:"controllers/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/init_patch/",children:"controllers/init_patch"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/initializer/",children:"controllers/initializer"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/patch_manager/",children:"controllers/patch_manager"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/custom_transport/",children:"logging/custom_transport"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/logging/",children:"logging/logging"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Collector/",children:"structures/Collector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Dialog/",children:"structures/Dialog"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/MessageCollector/",children:"structures/MessageCollector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/preProcessors/",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(t,{...e})}):t(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var c=n(6540);const s={},i=c.createContext(s);function l(e){const r=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),c.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a4e3797.02b74727.js b/assets/js/1a4e3797.02b74727.js new file mode 100644 index 0000000000..c9c7262c72 --- /dev/null +++ b/assets/js/1a4e3797.02b74727.js @@ -0,0 +1,2 @@ +/*! For license information please see 1a4e3797.02b74727.js.LICENSE.txt */ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2138],{2733:e=>{function t(){this._events=this._events||{},this._maxListeners=this._maxListeners||void 0}function r(e){return"function"==typeof e}function n(e){return"object"==typeof e&&null!==e}function i(e){return void 0===e}e.exports=t,t.prototype._events=void 0,t.prototype._maxListeners=void 0,t.defaultMaxListeners=10,t.prototype.setMaxListeners=function(e){if("number"!=typeof e||e<0||isNaN(e))throw TypeError("n must be a positive number");return this._maxListeners=e,this},t.prototype.emit=function(e){var t,s,a,c,o,u;if(this._events||(this._events={}),"error"===e&&(!this._events.error||n(this._events.error)&&!this._events.error.length)){if((t=arguments[1])instanceof Error)throw t;var h=new Error('Uncaught, unspecified "error" event. ('+t+")");throw h.context=t,h}if(i(s=this._events[e]))return!1;if(r(s))switch(arguments.length){case 1:s.call(this);break;case 2:s.call(this,arguments[1]);break;case 3:s.call(this,arguments[1],arguments[2]);break;default:c=Array.prototype.slice.call(arguments,1),s.apply(this,c)}else if(n(s))for(c=Array.prototype.slice.call(arguments,1),a=(u=s.slice()).length,o=0;o0&&this._events[e].length>a&&(this._events[e].warned=!0,console.error("(node) warning: possible EventEmitter memory leak detected. %d listeners added. Use emitter.setMaxListeners() to increase limit.",this._events[e].length),"function"==typeof console.trace&&console.trace()),this},t.prototype.on=t.prototype.addListener,t.prototype.once=function(e,t){if(!r(t))throw TypeError("listener must be a function");var n=!1;function i(){this.removeListener(e,i),n||(n=!0,t.apply(this,arguments))}return i.listener=t,this.on(e,i),this},t.prototype.removeListener=function(e,t){var i,s,a,c;if(!r(t))throw TypeError("listener must be a function");if(!this._events||!this._events[e])return this;if(a=(i=this._events[e]).length,s=-1,i===t||r(i.listener)&&i.listener===t)delete this._events[e],this._events.removeListener&&this.emit("removeListener",e,t);else if(n(i)){for(c=a;c-- >0;)if(i[c]===t||i[c].listener&&i[c].listener===t){s=c;break}if(s<0)return this;1===i.length?(i.length=0,delete this._events[e]):i.splice(s,1),this._events.removeListener&&this.emit("removeListener",e,t)}return this},t.prototype.removeAllListeners=function(e){var t,n;if(!this._events)return this;if(!this._events.removeListener)return 0===arguments.length?this._events={}:this._events[e]&&delete this._events[e],this;if(0===arguments.length){for(t in this._events)"removeListener"!==t&&this.removeAllListeners(t);return this.removeAllListeners("removeListener"),this._events={},this}if(r(n=this._events[e]))this.removeListener(e,n);else if(n)for(;n.length;)this.removeListener(e,n[n.length-1]);return delete this._events[e],this},t.prototype.listeners=function(e){return this._events&&this._events[e]?r(this._events[e])?[this._events[e]]:this._events[e].slice():[]},t.prototype.listenerCount=function(e){if(this._events){var t=this._events[e];if(r(t))return 1;if(t)return t.length}return 0},t.listenerCount=function(e,t){return e.listenerCount(t)}},4103:(e,t,r)=>{"use strict";var n=r(6571),i=r(9127),s=r(2223),a=r(3371),c=r(7691);function o(e,t,r,i){return new n(e,t,r,i)}o.version=r(6938),o.AlgoliaSearchHelper=n,o.SearchParameters=a,o.RecommendParameters=i,o.SearchResults=c,o.RecommendResults=s,e.exports=o},6732:(e,t,r)=>{"use strict";var n=r(2733);function i(e,t,r){this.main=e,this.fn=t,this.recommendFn=r,this.lastResults=null,this.lastRecommendResults=null}r(3014)(i,n),i.prototype.detach=function(){this.removeAllListeners(),this.main.detachDerivedHelper(this)},i.prototype.getModifiedState=function(e){return this.fn(e)},i.prototype.getModifiedRecommendState=function(e){return this.recommendFn(e)},e.exports=i},9127:e=>{"use strict";function t(e){e=e||{},this.params=e.params||[]}t.prototype={constructor:t,addParams:function(e){var r=this.params.slice();return r.push(e),new t({params:r})},removeParams:function(e){return new t({params:this.params.filter((function(t){return t.$$id!==e}))})},addFrequentlyBoughtTogether:function(e){return this.addParams(Object.assign({},e,{model:"bought-together"}))},addRelatedProducts:function(e){return this.addParams(Object.assign({},e,{model:"related-products"}))},addTrendingItems:function(e){return this.addParams(Object.assign({},e,{model:"trending-items"}))},addTrendingFacets:function(e){return this.addParams(Object.assign({},e,{model:"trending-facets"}))},addLookingSimilar:function(e){return this.addParams(Object.assign({},e,{model:"looking-similar"}))},_buildQueries:function(e,t){return this.params.filter((function(e){return void 0===t[e.$$id]})).map((function(t){var r=Object.assign({},t,{indexName:e,threshold:t.threshold||0});return delete r.$$id,r}))}},e.exports=t},2223:e=>{"use strict";function t(e,t){this._state=e,this._rawResults={};var r=this;e.params.forEach((function(e){var n=e.$$id;r[n]=t[n],r._rawResults[n]=t[n]}))}t.prototype={constructor:t},e.exports=t},1673:(e,t,r)=>{"use strict";var n=r(9110),i=r(317),s=r(1383),a={addRefinement:function(e,t,r){if(a.isRefined(e,t,r))return e;var i=""+r,s=e[t]?e[t].concat(i):[i],c={};return c[t]=s,n({},c,e)},removeRefinement:function(e,t,r){if(void 0===r)return a.clearRefinement(e,(function(e,r){return t===r}));var n=""+r;return a.clearRefinement(e,(function(e,r){return t===r&&n===e}))},toggleRefinement:function(e,t,r){if(void 0===r)throw new Error("toggleRefinement should be used with a value");return a.isRefined(e,t,r)?a.removeRefinement(e,t,r):a.addRefinement(e,t,r)},clearRefinement:function(e,t,r){if(void 0===t)return i(e)?{}:e;if("string"==typeof t)return s(e,[t]);if("function"==typeof t){var n=!1,a=Object.keys(e).reduce((function(i,s){var a=e[s]||[],c=a.filter((function(e){return!t(e,s,r)}));return c.length!==a.length&&(n=!0),i[s]=c,i}),{});return n?a:e}},isRefined:function(e,t,r){var n=Boolean(e[t])&&e[t].length>0;if(void 0===r||!n)return n;var i=""+r;return-1!==e[t].indexOf(i)}};e.exports=a},3371:(e,t,r)=>{"use strict";var n=r(9110),i=r(849),s=r(4843),a=r(4728),c=r(317),o=r(1383),u=r(7507),h=r(2208),f=r(1673);function l(e,t){return Array.isArray(e)&&Array.isArray(t)?e.length===t.length&&e.every((function(e,r){return l(t[r],e)})):e===t}function m(e){var t=e?m._parseNumbers(e):{};void 0===t.userToken||h(t.userToken)||console.warn("[algoliasearch-helper] The `userToken` parameter is invalid. This can lead to wrong analytics.\n - Format: [a-zA-Z0-9_-]{1,64}"),this.facets=t.facets||[],this.disjunctiveFacets=t.disjunctiveFacets||[],this.hierarchicalFacets=t.hierarchicalFacets||[],this.facetsRefinements=t.facetsRefinements||{},this.facetsExcludes=t.facetsExcludes||{},this.disjunctiveFacetsRefinements=t.disjunctiveFacetsRefinements||{},this.numericRefinements=t.numericRefinements||{},this.tagRefinements=t.tagRefinements||[],this.hierarchicalFacetsRefinements=t.hierarchicalFacetsRefinements||{};var r=this;Object.keys(t).forEach((function(e){var n=-1!==m.PARAMETERS.indexOf(e),i=void 0!==t[e];!n&&i&&(r[e]=t[e])}))}m.PARAMETERS=Object.keys(new m),m._parseNumbers=function(e){if(e instanceof m)return e;var t={};if(["aroundPrecision","aroundRadius","getRankingInfo","minWordSizefor2Typos","minWordSizefor1Typo","page","maxValuesPerFacet","distinct","minimumAroundRadius","hitsPerPage","minProximity"].forEach((function(r){var n=e[r];if("string"==typeof n){var i=parseFloat(n);t[r]=isNaN(i)?n:i}})),Array.isArray(e.insideBoundingBox)&&(t.insideBoundingBox=e.insideBoundingBox.map((function(e){return Array.isArray(e)?e.map((function(e){return parseFloat(e)})):e}))),e.numericRefinements){var r={};Object.keys(e.numericRefinements).forEach((function(t){var n=e.numericRefinements[t]||{};r[t]={},Object.keys(n).forEach((function(e){var i=n[e].map((function(e){return Array.isArray(e)?e.map((function(e){return"string"==typeof e?parseFloat(e):e})):"string"==typeof e?parseFloat(e):e}));r[t][e]=i}))})),t.numericRefinements=r}return a(e,t)},m.make=function(e){var t=new m(e);return(e.hierarchicalFacets||[]).forEach((function(e){if(e.rootPath){var r=t.getHierarchicalRefinement(e.name);r.length>0&&0!==r[0].indexOf(e.rootPath)&&(t=t.clearRefinements(e.name)),0===(r=t.getHierarchicalRefinement(e.name)).length&&(t=t.toggleHierarchicalFacetRefinement(e.name,e.rootPath))}})),t},m.validate=function(e,t){var r=t||{};return e.tagFilters&&r.tagRefinements&&r.tagRefinements.length>0?new Error("[Tags] Cannot switch from the managed tag API to the advanced API. It is probably an error, if it is really what you want, you should first clear the tags with clearTags method."):e.tagRefinements.length>0&&r.tagFilters?new Error("[Tags] Cannot switch from the advanced tag API to the managed API. It is probably an error, if it is not, you should first clear the tags with clearTags method."):e.numericFilters&&r.numericRefinements&&c(r.numericRefinements)?new Error("[Numeric filters] Can't switch from the advanced to the managed API. It is probably an error, if this is really what you want, you have to first clear the numeric filters."):c(e.numericRefinements)&&r.numericFilters?new Error("[Numeric filters] Can't switch from the managed API to the advanced. It is probably an error, if this is really what you want, you have to first clear the numeric filters."):null},m.prototype={constructor:m,clearRefinements:function(e){var t={numericRefinements:this._clearNumericRefinements(e),facetsRefinements:f.clearRefinement(this.facetsRefinements,e,"conjunctiveFacet"),facetsExcludes:f.clearRefinement(this.facetsExcludes,e,"exclude"),disjunctiveFacetsRefinements:f.clearRefinement(this.disjunctiveFacetsRefinements,e,"disjunctiveFacet"),hierarchicalFacetsRefinements:f.clearRefinement(this.hierarchicalFacetsRefinements,e,"hierarchicalFacet")};return t.numericRefinements===this.numericRefinements&&t.facetsRefinements===this.facetsRefinements&&t.facetsExcludes===this.facetsExcludes&&t.disjunctiveFacetsRefinements===this.disjunctiveFacetsRefinements&&t.hierarchicalFacetsRefinements===this.hierarchicalFacetsRefinements?this:this.setQueryParameters(t)},clearTags:function(){return void 0===this.tagFilters&&0===this.tagRefinements.length?this:this.setQueryParameters({tagFilters:void 0,tagRefinements:[]})},setIndex:function(e){return e===this.index?this:this.setQueryParameters({index:e})},setQuery:function(e){return e===this.query?this:this.setQueryParameters({query:e})},setPage:function(e){return e===this.page?this:this.setQueryParameters({page:e})},setFacets:function(e){return this.setQueryParameters({facets:e})},setDisjunctiveFacets:function(e){return this.setQueryParameters({disjunctiveFacets:e})},setHitsPerPage:function(e){return this.hitsPerPage===e?this:this.setQueryParameters({hitsPerPage:e})},setTypoTolerance:function(e){return this.typoTolerance===e?this:this.setQueryParameters({typoTolerance:e})},addNumericRefinement:function(e,t,r){var n=u(r);if(this.isNumericRefined(e,t,n))return this;var i=a({},this.numericRefinements);return i[e]=a({},i[e]),i[e][t]?(i[e][t]=i[e][t].slice(),i[e][t].push(n)):i[e][t]=[n],this.setQueryParameters({numericRefinements:i})},getConjunctiveRefinements:function(e){return this.isConjunctiveFacet(e)&&this.facetsRefinements[e]||[]},getDisjunctiveRefinements:function(e){return this.isDisjunctiveFacet(e)&&this.disjunctiveFacetsRefinements[e]||[]},getHierarchicalRefinement:function(e){return this.hierarchicalFacetsRefinements[e]||[]},getExcludeRefinements:function(e){return this.isConjunctiveFacet(e)&&this.facetsExcludes[e]||[]},removeNumericRefinement:function(e,t,r){var n=r;return void 0!==n?this.isNumericRefined(e,t,n)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(r,i){return i===e&&r.op===t&&l(r.val,u(n))}))}):this:void 0!==t?this.isNumericRefined(e,t)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(r,n){return n===e&&r.op===t}))}):this:this.isNumericRefined(e)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(t,r){return r===e}))}):this},getNumericRefinements:function(e){return this.numericRefinements[e]||{}},getNumericRefinement:function(e,t){return this.numericRefinements[e]&&this.numericRefinements[e][t]},_clearNumericRefinements:function(e){if(void 0===e)return c(this.numericRefinements)?{}:this.numericRefinements;if("string"==typeof e)return o(this.numericRefinements,[e]);if("function"==typeof e){var t=!1,r=this.numericRefinements,n=Object.keys(r).reduce((function(n,i){var s=r[i],a={};return s=s||{},Object.keys(s).forEach((function(r){var n=s[r]||[],c=[];n.forEach((function(t){e({val:t,op:r},i,"numeric")||c.push(t)})),c.length!==n.length&&(t=!0),a[r]=c})),n[i]=a,n}),{});return t?n:this.numericRefinements}},addFacet:function(e){return this.isConjunctiveFacet(e)?this:this.setQueryParameters({facets:this.facets.concat([e])})},addDisjunctiveFacet:function(e){return this.isDisjunctiveFacet(e)?this:this.setQueryParameters({disjunctiveFacets:this.disjunctiveFacets.concat([e])})},addHierarchicalFacet:function(e){if(this.isHierarchicalFacet(e.name))throw new Error("Cannot declare two hierarchical facets with the same name: `"+e.name+"`");return this.setQueryParameters({hierarchicalFacets:this.hierarchicalFacets.concat([e])})},addFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsRefinements,e,t)?this:this.setQueryParameters({facetsRefinements:f.addRefinement(this.facetsRefinements,e,t)})},addExcludeRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsExcludes,e,t)?this:this.setQueryParameters({facetsExcludes:f.addRefinement(this.facetsExcludes,e,t)})},addDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return f.isRefined(this.disjunctiveFacetsRefinements,e,t)?this:this.setQueryParameters({disjunctiveFacetsRefinements:f.addRefinement(this.disjunctiveFacetsRefinements,e,t)})},addTagRefinement:function(e){if(this.isTagRefined(e))return this;var t={tagRefinements:this.tagRefinements.concat(e)};return this.setQueryParameters(t)},removeFacet:function(e){return this.isConjunctiveFacet(e)?this.clearRefinements(e).setQueryParameters({facets:this.facets.filter((function(t){return t!==e}))}):this},removeDisjunctiveFacet:function(e){return this.isDisjunctiveFacet(e)?this.clearRefinements(e).setQueryParameters({disjunctiveFacets:this.disjunctiveFacets.filter((function(t){return t!==e}))}):this},removeHierarchicalFacet:function(e){return this.isHierarchicalFacet(e)?this.clearRefinements(e).setQueryParameters({hierarchicalFacets:this.hierarchicalFacets.filter((function(t){return t.name!==e}))}):this},removeFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsRefinements,e,t)?this.setQueryParameters({facetsRefinements:f.removeRefinement(this.facetsRefinements,e,t)}):this},removeExcludeRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsExcludes,e,t)?this.setQueryParameters({facetsExcludes:f.removeRefinement(this.facetsExcludes,e,t)}):this},removeDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return f.isRefined(this.disjunctiveFacetsRefinements,e,t)?this.setQueryParameters({disjunctiveFacetsRefinements:f.removeRefinement(this.disjunctiveFacetsRefinements,e,t)}):this},removeTagRefinement:function(e){if(!this.isTagRefined(e))return this;var t={tagRefinements:this.tagRefinements.filter((function(t){return t!==e}))};return this.setQueryParameters(t)},toggleRefinement:function(e,t){return this.toggleFacetRefinement(e,t)},toggleFacetRefinement:function(e,t){if(this.isHierarchicalFacet(e))return this.toggleHierarchicalFacetRefinement(e,t);if(this.isConjunctiveFacet(e))return this.toggleConjunctiveFacetRefinement(e,t);if(this.isDisjunctiveFacet(e))return this.toggleDisjunctiveFacetRefinement(e,t);throw new Error("Cannot refine the undeclared facet "+e+"; it should be added to the helper options facets, disjunctiveFacets or hierarchicalFacets")},toggleConjunctiveFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return this.setQueryParameters({facetsRefinements:f.toggleRefinement(this.facetsRefinements,e,t)})},toggleExcludeFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return this.setQueryParameters({facetsExcludes:f.toggleRefinement(this.facetsExcludes,e,t)})},toggleDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return this.setQueryParameters({disjunctiveFacetsRefinements:f.toggleRefinement(this.disjunctiveFacetsRefinements,e,t)})},toggleHierarchicalFacetRefinement:function(e,t){if(!this.isHierarchicalFacet(e))throw new Error(e+" is not defined in the hierarchicalFacets attribute of the helper configuration");var r=this._getHierarchicalFacetSeparator(this.getHierarchicalFacetByName(e)),i={};return void 0!==this.hierarchicalFacetsRefinements[e]&&this.hierarchicalFacetsRefinements[e].length>0&&(this.hierarchicalFacetsRefinements[e][0]===t||0===this.hierarchicalFacetsRefinements[e][0].indexOf(t+r))?-1===t.indexOf(r)?i[e]=[]:i[e]=[t.slice(0,t.lastIndexOf(r))]:i[e]=[t],this.setQueryParameters({hierarchicalFacetsRefinements:n({},i,this.hierarchicalFacetsRefinements)})},addHierarchicalFacetRefinement:function(e,t){if(this.isHierarchicalFacetRefined(e))throw new Error(e+" is already refined.");if(!this.isHierarchicalFacet(e))throw new Error(e+" is not defined in the hierarchicalFacets attribute of the helper configuration.");var r={};return r[e]=[t],this.setQueryParameters({hierarchicalFacetsRefinements:n({},r,this.hierarchicalFacetsRefinements)})},removeHierarchicalFacetRefinement:function(e){if(!this.isHierarchicalFacetRefined(e))return this;var t={};return t[e]=[],this.setQueryParameters({hierarchicalFacetsRefinements:n({},t,this.hierarchicalFacetsRefinements)})},toggleTagRefinement:function(e){return this.isTagRefined(e)?this.removeTagRefinement(e):this.addTagRefinement(e)},isDisjunctiveFacet:function(e){return this.disjunctiveFacets.indexOf(e)>-1},isHierarchicalFacet:function(e){return void 0!==this.getHierarchicalFacetByName(e)},isConjunctiveFacet:function(e){return this.facets.indexOf(e)>-1},isFacetRefined:function(e,t){return!!this.isConjunctiveFacet(e)&&f.isRefined(this.facetsRefinements,e,t)},isExcludeRefined:function(e,t){return!!this.isConjunctiveFacet(e)&&f.isRefined(this.facetsExcludes,e,t)},isDisjunctiveFacetRefined:function(e,t){return!!this.isDisjunctiveFacet(e)&&f.isRefined(this.disjunctiveFacetsRefinements,e,t)},isHierarchicalFacetRefined:function(e,t){if(!this.isHierarchicalFacet(e))return!1;var r=this.getHierarchicalRefinement(e);return t?-1!==r.indexOf(t):r.length>0},isNumericRefined:function(e,t,r){if(void 0===r&&void 0===t)return Boolean(this.numericRefinements[e]);var n=this.numericRefinements[e]&&void 0!==this.numericRefinements[e][t];if(void 0===r||!n)return n;var s,a,c=u(r),o=void 0!==(s=this.numericRefinements[e][t],a=c,i(s,(function(e){return l(e,a)})));return n&&o},isTagRefined:function(e){return-1!==this.tagRefinements.indexOf(e)},getRefinedDisjunctiveFacets:function(){var e=this,t=s(Object.keys(this.numericRefinements).filter((function(t){return Object.keys(e.numericRefinements[t]).length>0})),this.disjunctiveFacets);return Object.keys(this.disjunctiveFacetsRefinements).filter((function(t){return e.disjunctiveFacetsRefinements[t].length>0})).concat(t).concat(this.getRefinedHierarchicalFacets()).sort()},getRefinedHierarchicalFacets:function(){var e=this;return s(this.hierarchicalFacets.map((function(e){return e.name})),Object.keys(this.hierarchicalFacetsRefinements).filter((function(t){return e.hierarchicalFacetsRefinements[t].length>0}))).sort()},getUnrefinedDisjunctiveFacets:function(){var e=this.getRefinedDisjunctiveFacets();return this.disjunctiveFacets.filter((function(t){return-1===e.indexOf(t)}))},managedParameters:["index","facets","disjunctiveFacets","facetsRefinements","hierarchicalFacets","facetsExcludes","disjunctiveFacetsRefinements","numericRefinements","tagRefinements","hierarchicalFacetsRefinements"],getQueryParams:function(){var e=this.managedParameters,t={},r=this;return Object.keys(this).forEach((function(n){var i=r[n];-1===e.indexOf(n)&&void 0!==i&&(t[n]=i)})),t},setQueryParameter:function(e,t){if(this[e]===t)return this;var r={};return r[e]=t,this.setQueryParameters(r)},setQueryParameters:function(e){if(!e)return this;var t=m.validate(this,e);if(t)throw t;var r=this,n=m._parseNumbers(e),i=Object.keys(this).reduce((function(e,t){return e[t]=r[t],e}),{}),s=Object.keys(n).reduce((function(e,t){var r=void 0!==e[t],i=void 0!==n[t];return r&&!i?o(e,[t]):(i&&(e[t]=n[t]),e)}),i);return new this.constructor(s)},resetPage:function(){return void 0===this.page?this:this.setPage(0)},_getHierarchicalFacetSortBy:function(e){return e.sortBy||["isRefined:desc","name:asc"]},_getHierarchicalFacetSeparator:function(e){return e.separator||" > "},_getHierarchicalRootPath:function(e){return e.rootPath||null},_getHierarchicalShowParentLevel:function(e){return"boolean"!=typeof e.showParentLevel||e.showParentLevel},getHierarchicalFacetByName:function(e){return i(this.hierarchicalFacets,(function(t){return t.name===e}))},getHierarchicalFacetBreadcrumb:function(e){if(!this.isHierarchicalFacet(e))return[];var t=this.getHierarchicalRefinement(e)[0];if(!t)return[];var r=this._getHierarchicalFacetSeparator(this.getHierarchicalFacetByName(e));return t.split(r).map((function(e){return e.trim()}))},toString:function(){return JSON.stringify(this,null,2)}},e.exports=m},6673:(e,t,r)=>{"use strict";e.exports=function(e){return function(t,r){var n=e.hierarchicalFacets[r],u=e.hierarchicalFacetsRefinements[n.name]&&e.hierarchicalFacetsRefinements[n.name][0]||"",h=e._getHierarchicalFacetSeparator(n),f=e._getHierarchicalRootPath(n),l=e._getHierarchicalShowParentLevel(n),m=s(e._getHierarchicalFacetSortBy(n)),d=t.every((function(e){return e.exhaustive})),p=function(e,t,r,n,s){return function(u,h,f){var l=u;if(f>0){var m=0;for(l=u;m{"use strict";var n=r(8965),i=r(9110),s=r(2909),a=r(849),c=r(3917),o=r(7577),u=r(4728),h=r(8601),f=s.escapeFacetValue,l=s.unescapeFacetValue,m=r(6673);function d(e){var t={};return e.forEach((function(e,r){t[e]=r})),t}function p(e,t,r){t&&t[r]&&(e.stats=t[r])}function g(e,t,r){var s=t[0]||{};this._rawResults=t;var o=this;Object.keys(s).forEach((function(e){o[e]=s[e]}));var h=u({persistHierarchicalRootCount:!1},r);Object.keys(h).forEach((function(e){o[e]=h[e]})),this.processingTimeMS=t.reduce((function(e,t){return void 0===t.processingTimeMS?e:e+t.processingTimeMS}),0),this.disjunctiveFacets=[],this.hierarchicalFacets=e.hierarchicalFacets.map((function(){return[]})),this.facets=[];var f=e.getRefinedDisjunctiveFacets(),g=d(e.facets),v=d(e.disjunctiveFacets),y=1,R=s.facets||{};Object.keys(R).forEach((function(t){var r,n,i=R[t],u=(r=e.hierarchicalFacets,n=t,a(r,(function(e){return(e.attributes||[]).indexOf(n)>-1})));if(u){var h=u.attributes.indexOf(t),f=c(e.hierarchicalFacets,(function(e){return e.name===u.name}));o.hierarchicalFacets[f][h]={attribute:t,data:i,exhaustive:s.exhaustiveFacetsCount}}else{var l,m=-1!==e.disjunctiveFacets.indexOf(t),d=-1!==e.facets.indexOf(t);m&&(l=v[t],o.disjunctiveFacets[l]={name:t,data:i,exhaustive:s.exhaustiveFacetsCount},p(o.disjunctiveFacets[l],s.facets_stats,t)),d&&(l=g[t],o.facets[l]={name:t,data:i,exhaustive:s.exhaustiveFacetsCount},p(o.facets[l],s.facets_stats,t))}})),this.hierarchicalFacets=n(this.hierarchicalFacets),f.forEach((function(r){var n=t[y],a=n&&n.facets?n.facets:{},h=e.getHierarchicalFacetByName(r);Object.keys(a).forEach((function(t){var r,f=a[t];if(h){r=c(e.hierarchicalFacets,(function(e){return e.name===h.name}));var m=c(o.hierarchicalFacets[r],(function(e){return e.attribute===t}));if(-1===m)return;o.hierarchicalFacets[r][m].data=u({},o.hierarchicalFacets[r][m].data,f)}else{r=v[t];var d=s.facets&&s.facets[t]||{};o.disjunctiveFacets[r]={name:t,data:i({},f,d),exhaustive:n.exhaustiveFacetsCount},p(o.disjunctiveFacets[r],n.facets_stats,t),e.disjunctiveFacetsRefinements[t]&&e.disjunctiveFacetsRefinements[t].forEach((function(n){!o.disjunctiveFacets[r].data[n]&&e.disjunctiveFacetsRefinements[t].indexOf(l(n))>-1&&(o.disjunctiveFacets[r].data[n]=0)}))}})),y++})),e.getRefinedHierarchicalFacets().forEach((function(r){var n=e.getHierarchicalFacetByName(r),s=e._getHierarchicalFacetSeparator(n),a=e.getHierarchicalRefinement(r);0===a.length||a[0].split(s).length<2||t.slice(y).forEach((function(t){var r=t&&t.facets?t.facets:{};Object.keys(r).forEach((function(t){var u=r[t],h=c(e.hierarchicalFacets,(function(e){return e.name===n.name})),f=c(o.hierarchicalFacets[h],(function(e){return e.attribute===t}));if(-1!==f){var l={};if(a.length>0&&!o.persistHierarchicalRootCount){var m=a[0].split(s)[0];l[m]=o.hierarchicalFacets[h][f].data[m]}o.hierarchicalFacets[h][f].data=i(l,u,o.hierarchicalFacets[h][f].data)}})),y++}))})),Object.keys(e.facetsExcludes).forEach((function(t){var r=e.facetsExcludes[t],n=g[t];o.facets[n]={name:t,data:R[t],exhaustive:s.exhaustiveFacetsCount},r.forEach((function(e){o.facets[n]=o.facets[n]||{name:t},o.facets[n].data=o.facets[n].data||{},o.facets[n].data[e]=0}))})),this.hierarchicalFacets=this.hierarchicalFacets.map(m(e)),this.facets=n(this.facets),this.disjunctiveFacets=n(this.disjunctiveFacets),this._state=e}function v(e,t){function r(e){return e.name===t}if(e._state.isConjunctiveFacet(t)){var n=a(e.facets,r);return n?Object.keys(n.data).map((function(r){var i=f(r);return{name:r,escapedValue:i,count:n.data[r],isRefined:e._state.isFacetRefined(t,i),isExcluded:e._state.isExcludeRefined(t,r)}})):[]}if(e._state.isDisjunctiveFacet(t)){var i=a(e.disjunctiveFacets,r);return i?Object.keys(i.data).map((function(r){var n=f(r);return{name:r,escapedValue:n,count:i.data[r],isRefined:e._state.isDisjunctiveFacetRefined(t,n)}})):[]}if(e._state.isHierarchicalFacet(t)){var s=a(e.hierarchicalFacets,r);if(!s)return s;var c=e._state.getHierarchicalFacetByName(t),o=e._state._getHierarchicalFacetSeparator(c),u=l(e._state.getHierarchicalRefinement(t)[0]||"");0===u.indexOf(c.rootPath)&&(u=u.replace(c.rootPath+o,""));var h=u.split(o);return h.unshift(t),y(s,h,0),s}}function y(e,t,r){e.isRefined=e.name===(t[r]&&t[r].trim()),e.data&&e.data.forEach((function(e){y(e,t,r+1)}))}function R(e,t,r,n){if(n=n||0,Array.isArray(t))return e(t,r[n]);if(!t.data||0===t.data.length)return t;var s=t.data.map((function(t){return R(e,t,r,n+1)})),a=e(s,r[n]);return i({data:a},t)}function F(e,t){var r=a(e,(function(e){return e.name===t}));return r&&r.stats}function b(e,t,r,n,i){var s=a(i,(function(e){return e.name===r})),c=s&&s.data&&s.data[n]?s.data[n]:0,o=s&&s.exhaustive||!1;return{type:t,attributeName:r,name:n,count:c,exhaustive:o}}g.prototype.getFacetByName=function(e){function t(t){return t.name===e}return a(this.facets,t)||a(this.disjunctiveFacets,t)||a(this.hierarchicalFacets,t)},g.DEFAULT_SORT=["isRefined:desc","count:desc","name:asc"],g.prototype.getFacetValues=function(e,t){var r=v(this,e);if(r){var n,s=i({},t,{sortBy:g.DEFAULT_SORT,facetOrdering:!(t&&t.sortBy)}),a=this;if(Array.isArray(r))n=[e];else n=a._state.getHierarchicalFacetByName(r.name).attributes;return R((function(e,t){if(s.facetOrdering){var r=function(e,t){return e.renderingContent&&e.renderingContent.facetOrdering&&e.renderingContent.facetOrdering.values&&e.renderingContent.facetOrdering.values[t]}(a,t);if(r)return function(e,t){var r=[],n=[],i=t.hide||[],s=(t.order||[]).reduce((function(e,t,r){return e[t]=r,e}),{});e.forEach((function(e){var t=e.path||e.name,a=i.indexOf(t)>-1;a||void 0===s[t]?a||n.push(e):r[s[t]]=e})),r=r.filter((function(e){return e}));var a,c=t.sortRemainingBy;return"hidden"===c?r:(a="alpha"===c?[["path","name"],["asc","asc"]]:[["count"],["desc"]],r.concat(h(n,a[0],a[1])))}(e,r)}if(Array.isArray(s.sortBy)){var n=o(s.sortBy,g.DEFAULT_SORT);return h(e,n[0],n[1])}if("function"==typeof s.sortBy)return function(e,t){return t.sort(e)}(s.sortBy,e);throw new Error("options.sortBy is optional but if defined it must be either an array of string (predicates) or a sorting function")}),r,n)}},g.prototype.getFacetStats=function(e){return this._state.isConjunctiveFacet(e)?F(this.facets,e):this._state.isDisjunctiveFacet(e)?F(this.disjunctiveFacets,e):void 0},g.prototype.getRefinements=function(){var e=this._state,t=this,r=[];return Object.keys(e.facetsRefinements).forEach((function(n){e.facetsRefinements[n].forEach((function(i){r.push(b(e,"facet",n,i,t.facets))}))})),Object.keys(e.facetsExcludes).forEach((function(n){e.facetsExcludes[n].forEach((function(i){r.push(b(e,"exclude",n,i,t.facets))}))})),Object.keys(e.disjunctiveFacetsRefinements).forEach((function(n){e.disjunctiveFacetsRefinements[n].forEach((function(i){r.push(b(e,"disjunctive",n,i,t.disjunctiveFacets))}))})),Object.keys(e.hierarchicalFacetsRefinements).forEach((function(n){e.hierarchicalFacetsRefinements[n].forEach((function(i){r.push(function(e,t,r,n){var i=e.getHierarchicalFacetByName(t),s=e._getHierarchicalFacetSeparator(i),c=r.split(s),o=a(n,(function(e){return e.name===t})),u=c.reduce((function(e,t){var r=e&&a(e.data,(function(e){return e.name===t}));return void 0!==r?r:e}),o),h=u&&u.count||0,f=u&&u.exhaustive||!1,l=u&&u.path||"";return{type:"hierarchical",attributeName:t,name:l,count:h,exhaustive:f}}(e,n,i,t.hierarchicalFacets))}))})),Object.keys(e.numericRefinements).forEach((function(t){var n=e.numericRefinements[t];Object.keys(n).forEach((function(e){n[e].forEach((function(n){r.push({type:"numeric",attributeName:t,name:n,numericValue:n,operator:e})}))}))})),e.tagRefinements.forEach((function(e){r.push({type:"tag",attributeName:"_tags",name:e})})),r},e.exports=g},6571:(e,t,r)=>{"use strict";var n=r(2733),i=r(6732),s=r(2909).escapeFacetValue,a=r(3014),c=r(4728),o=r(317),u=r(1383),h=r(9127),f=r(2223),l=r(9228),m=r(3371),d=r(7691),p=r(7749),g=r(6938);function v(e,t,r,n){"function"==typeof e.addAlgoliaAgent&&e.addAlgoliaAgent("JS Helper ("+g+")"),this.setClient(e);var i=r||{};i.index=t,this.state=m.make(i),this.recommendState=new h({params:i.recommendState}),this.lastResults=null,this.lastRecommendResults=null,this._queryId=0,this._recommendQueryId=0,this._lastQueryIdReceived=-1,this._lastRecommendQueryIdReceived=-1,this.derivedHelpers=[],this._currentNbQueries=0,this._currentNbRecommendQueries=0,this._searchResultsOptions=n,this._recommendCache={}}function y(e){if(e<0)throw new Error("Page requested below 0.");return this._change({state:this.state.setPage(e),isPageReset:!1}),this}function R(){return this.state.page}a(v,n),v.prototype.search=function(){return this._search({onlyWithDerivedHelpers:!1}),this},v.prototype.searchOnlyWithDerivedHelpers=function(){return this._search({onlyWithDerivedHelpers:!0}),this},v.prototype.recommend=function(){return this._recommend(),this},v.prototype.getQuery=function(){var e=this.state;return l._getHitsSearchParams(e)},v.prototype.searchOnce=function(e,t){var r=e?this.state.setQueryParameters(e):this.state,n=l._getQueries(r.index,r),i=this;if(this._currentNbQueries++,this.emit("searchOnce",{state:r}),!t)return this.client.search(n).then((function(e){return i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),{content:new d(r,e.results),state:r,_originalResponse:e}}),(function(e){throw i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),e}));this.client.search(n).then((function(e){i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),t(null,new d(r,e.results),r)})).catch((function(e){i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),t(e,null,r)}))},v.prototype.findAnswers=function(e){console.warn("[algoliasearch-helper] answers is no longer supported");var t=this.state,r=this.derivedHelpers[0];if(!r)return Promise.resolve([]);var n=r.getModifiedState(t),i=c({attributesForPrediction:e.attributesForPrediction,nbHits:e.nbHits},{params:u(l._getHitsSearchParams(n),["attributesToSnippet","hitsPerPage","restrictSearchableAttributes","snippetEllipsisText"])}),s="search for answers was called, but this client does not have a function client.initIndex(index).findAnswers";if("function"!=typeof this.client.initIndex)throw new Error(s);var a=this.client.initIndex(n.index);if("function"!=typeof a.findAnswers)throw new Error(s);return a.findAnswers(n.query,e.queryLanguages,i)},v.prototype.searchForFacetValues=function(e,t,r,n){var i="function"==typeof this.client.searchForFacetValues&&"function"!=typeof this.client.searchForFacets,a="function"==typeof this.client.initIndex;if(!i&&!a&&"function"!=typeof this.client.search)throw new Error("search for facet values (searchable) was called, but this client does not have a function client.searchForFacetValues or client.initIndex(index).searchForFacetValues");var c=this.state.setQueryParameters(n||{}),o=c.isDisjunctiveFacet(e),u=l.getSearchForFacetQuery(e,t,r,c);this._currentNbQueries++;var h,f=this;return i?h=this.client.searchForFacetValues([{indexName:c.index,params:u}]):a?h=this.client.initIndex(c.index).searchForFacetValues(u):(delete u.facetName,h=this.client.search([{type:"facet",facet:e,indexName:c.index,params:u}]).then((function(e){return e.results[0]}))),this.emit("searchForFacetValues",{state:c,facet:e,query:t}),h.then((function(t){return f._currentNbQueries--,0===f._currentNbQueries&&f.emit("searchQueueEmpty"),(t=Array.isArray(t)?t[0]:t).facetHits.forEach((function(t){t.escapedValue=s(t.value),t.isRefined=o?c.isDisjunctiveFacetRefined(e,t.escapedValue):c.isFacetRefined(e,t.escapedValue)})),t}),(function(e){throw f._currentNbQueries--,0===f._currentNbQueries&&f.emit("searchQueueEmpty"),e}))},v.prototype.setQuery=function(e){return this._change({state:this.state.resetPage().setQuery(e),isPageReset:!0}),this},v.prototype.clearRefinements=function(e){return this._change({state:this.state.resetPage().clearRefinements(e),isPageReset:!0}),this},v.prototype.clearTags=function(){return this._change({state:this.state.resetPage().clearTags(),isPageReset:!0}),this},v.prototype.addDisjunctiveFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addDisjunctiveFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addDisjunctiveRefine=function(){return this.addDisjunctiveFacetRefinement.apply(this,arguments)},v.prototype.addHierarchicalFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addHierarchicalFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addNumericRefinement=function(e,t,r){return this._change({state:this.state.resetPage().addNumericRefinement(e,t,r),isPageReset:!0}),this},v.prototype.addFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addRefine=function(){return this.addFacetRefinement.apply(this,arguments)},v.prototype.addFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().addExcludeRefinement(e,t),isPageReset:!0}),this},v.prototype.addExclude=function(){return this.addFacetExclusion.apply(this,arguments)},v.prototype.addTag=function(e){return this._change({state:this.state.resetPage().addTagRefinement(e),isPageReset:!0}),this},v.prototype.addFrequentlyBoughtTogether=function(e){return this._recommendChange({state:this.recommendState.addFrequentlyBoughtTogether(e)}),this},v.prototype.addRelatedProducts=function(e){return this._recommendChange({state:this.recommendState.addRelatedProducts(e)}),this},v.prototype.addTrendingItems=function(e){return this._recommendChange({state:this.recommendState.addTrendingItems(e)}),this},v.prototype.addTrendingFacets=function(e){return this._recommendChange({state:this.recommendState.addTrendingFacets(e)}),this},v.prototype.addLookingSimilar=function(e){return this._recommendChange({state:this.recommendState.addLookingSimilar(e)}),this},v.prototype.removeNumericRefinement=function(e,t,r){return this._change({state:this.state.resetPage().removeNumericRefinement(e,t,r),isPageReset:!0}),this},v.prototype.removeDisjunctiveFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().removeDisjunctiveFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.removeDisjunctiveRefine=function(){return this.removeDisjunctiveFacetRefinement.apply(this,arguments)},v.prototype.removeHierarchicalFacetRefinement=function(e){return this._change({state:this.state.resetPage().removeHierarchicalFacetRefinement(e),isPageReset:!0}),this},v.prototype.removeFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().removeFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.removeRefine=function(){return this.removeFacetRefinement.apply(this,arguments)},v.prototype.removeFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().removeExcludeRefinement(e,t),isPageReset:!0}),this},v.prototype.removeExclude=function(){return this.removeFacetExclusion.apply(this,arguments)},v.prototype.removeTag=function(e){return this._change({state:this.state.resetPage().removeTagRefinement(e),isPageReset:!0}),this},v.prototype.removeFrequentlyBoughtTogether=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeRelatedProducts=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeTrendingItems=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeTrendingFacets=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeLookingSimilar=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.toggleFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().toggleExcludeFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.toggleExclude=function(){return this.toggleFacetExclusion.apply(this,arguments)},v.prototype.toggleRefinement=function(e,t){return this.toggleFacetRefinement(e,t)},v.prototype.toggleFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().toggleFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.toggleRefine=function(){return this.toggleFacetRefinement.apply(this,arguments)},v.prototype.toggleTag=function(e){return this._change({state:this.state.resetPage().toggleTagRefinement(e),isPageReset:!0}),this},v.prototype.nextPage=function(){var e=this.state.page||0;return this.setPage(e+1)},v.prototype.previousPage=function(){var e=this.state.page||0;return this.setPage(e-1)},v.prototype.setCurrentPage=y,v.prototype.setPage=y,v.prototype.setIndex=function(e){return this._change({state:this.state.resetPage().setIndex(e),isPageReset:!0}),this},v.prototype.setQueryParameter=function(e,t){return this._change({state:this.state.resetPage().setQueryParameter(e,t),isPageReset:!0}),this},v.prototype.setState=function(e){return this._change({state:m.make(e),isPageReset:!1}),this},v.prototype.overrideStateWithoutTriggeringChangeEvent=function(e){return this.state=new m(e),this},v.prototype.hasRefinements=function(e){return!!o(this.state.getNumericRefinements(e))||(this.state.isConjunctiveFacet(e)?this.state.isFacetRefined(e):this.state.isDisjunctiveFacet(e)?this.state.isDisjunctiveFacetRefined(e):!!this.state.isHierarchicalFacet(e)&&this.state.isHierarchicalFacetRefined(e))},v.prototype.isExcluded=function(e,t){return this.state.isExcludeRefined(e,t)},v.prototype.isDisjunctiveRefined=function(e,t){return this.state.isDisjunctiveFacetRefined(e,t)},v.prototype.hasTag=function(e){return this.state.isTagRefined(e)},v.prototype.isTagRefined=function(){return this.hasTagRefinements.apply(this,arguments)},v.prototype.getIndex=function(){return this.state.index},v.prototype.getCurrentPage=R,v.prototype.getPage=R,v.prototype.getTags=function(){return this.state.tagRefinements},v.prototype.getRefinements=function(e){var t=[];if(this.state.isConjunctiveFacet(e))this.state.getConjunctiveRefinements(e).forEach((function(e){t.push({value:e,type:"conjunctive"})})),this.state.getExcludeRefinements(e).forEach((function(e){t.push({value:e,type:"exclude"})}));else if(this.state.isDisjunctiveFacet(e)){this.state.getDisjunctiveRefinements(e).forEach((function(e){t.push({value:e,type:"disjunctive"})}))}var r=this.state.getNumericRefinements(e);return Object.keys(r).forEach((function(e){var n=r[e];t.push({value:n,operator:e,type:"numeric"})})),t},v.prototype.getNumericRefinement=function(e,t){return this.state.getNumericRefinement(e,t)},v.prototype.getHierarchicalFacetBreadcrumb=function(e){return this.state.getHierarchicalFacetBreadcrumb(e)},v.prototype._search=function(e){var t=this.state,r=[],n=[];e.onlyWithDerivedHelpers||(n=l._getQueries(t.index,t),r.push({state:t,queriesCount:n.length,helper:this}),this.emit("search",{state:t,results:this.lastResults}));var i=this.derivedHelpers.map((function(e){var n=e.getModifiedState(t),i=n.index?l._getQueries(n.index,n):[];return r.push({state:n,queriesCount:i.length,helper:e}),e.emit("search",{state:n,results:e.lastResults}),i})),s=Array.prototype.concat.apply(n,i),a=this._queryId++;if(this._currentNbQueries++,!s.length)return Promise.resolve({results:[]}).then(this._dispatchAlgoliaResponse.bind(this,r,a));try{this.client.search(s).then(this._dispatchAlgoliaResponse.bind(this,r,a)).catch(this._dispatchAlgoliaError.bind(this,a))}catch(c){this.emit("error",{error:c})}},v.prototype._recommend=function(){var e=this.state,t=this.recommendState,r=this.getIndex(),n=[{state:t,index:r,helper:this}],i=t.params.map((function(e){return e.$$id}));this.emit("fetch",{recommend:{state:t,results:this.lastRecommendResults}});var s=this._recommendCache,a=this.derivedHelpers.map((function(t){var r=t.getModifiedState(e).index;if(!r)return[];var a=t.getModifiedRecommendState(new h);return n.push({state:a,index:r,helper:t}),i=Array.prototype.concat.apply(i,a.params.map((function(e){return e.$$id}))),t.emit("fetch",{recommend:{state:a,results:t.lastRecommendResults}}),a._buildQueries(r,s)})),c=Array.prototype.concat.apply(this.recommendState._buildQueries(r,s),a);if(0!==c.length)if(c.length>0&&void 0===this.client.getRecommendations)console.warn("Please update algoliasearch/lite to the latest version in order to use recommend widgets.");else{var o=this._recommendQueryId++;this._currentNbRecommendQueries++;try{this.client.getRecommendations(c).then(this._dispatchRecommendResponse.bind(this,o,n,i)).catch(this._dispatchRecommendError.bind(this,o))}catch(u){this.emit("error",{error:u})}}},v.prototype._dispatchAlgoliaResponse=function(e,t,r){var n=this;if(!(t0},v.prototype._change=function(e){var t=e.state,r=e.isPageReset;t!==this.state&&(this.state=t,this.emit("change",{state:this.state,results:this.lastResults,isPageReset:r}))},v.prototype._recommendChange=function(e){var t=e.state;t!==this.recommendState&&(this.recommendState=t,this.emit("recommend:change",{search:{results:this.lastResults,state:this.state},recommend:{results:this.lastRecommendResults,state:this.recommendState}}))},v.prototype.clearCache=function(){return this.client.clearCache&&this.client.clearCache(),this},v.prototype.setClient=function(e){return this.client===e||("function"==typeof e.addAlgoliaAgent&&e.addAlgoliaAgent("JS Helper ("+g+")"),this.client=e),this},v.prototype.getClient=function(){return this.client},v.prototype.derive=function(e,t){var r=new i(this,e,t);return this.derivedHelpers.push(r),r},v.prototype.detachDerivedHelper=function(e){var t=this.derivedHelpers.indexOf(e);if(-1===t)throw new Error("Derived helper already detached");this.derivedHelpers.splice(t,1)},v.prototype.hasPendingRequests=function(){return this._currentNbQueries>0},e.exports=v},8965:e=>{"use strict";e.exports=function(e){return Array.isArray(e)?e.filter(Boolean):[]}},9110:e=>{"use strict";e.exports=function(){return Array.prototype.slice.call(arguments).reduceRight((function(e,t){return Object.keys(Object(t)).forEach((function(r){void 0!==t[r]&&(void 0!==e[r]&&delete e[r],e[r]=t[r])})),e}),{})}},2909:e=>{"use strict";e.exports={escapeFacetValue:function(e){return"string"!=typeof e?e:String(e).replace(/^-/,"\\-")},unescapeFacetValue:function(e){return"string"!=typeof e?e:e.replace(/^\\-/,"-")}}},849:e=>{"use strict";e.exports=function(e,t){if(Array.isArray(e))for(var r=0;r{"use strict";e.exports=function(e,t){if(!Array.isArray(e))return-1;for(var r=0;r{e.exports=function(e){return e.reduce((function(e,t){return e.concat(t)}),[])}},7577:(e,t,r)=>{"use strict";var n=r(849);e.exports=function(e,t){var r=(t||[]).map((function(e){return e.split(":")}));return e.reduce((function(e,t){var i=t.split(":"),s=n(r,(function(e){return e[0]===i[0]}));return i.length>1||!s?(e[0].push(i[0]),e[1].push(i[1]),e):(e[0].push(s[0]),e[1].push(s[1]),e)}),[[],[]])}},3014:e=>{"use strict";e.exports=function(e,t){e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}})}},4843:e=>{"use strict";e.exports=function(e,t){return e.filter((function(r,n){return t.indexOf(r)>-1&&e.indexOf(r)===n}))}},4728:e=>{"use strict";function t(e){return"function"==typeof e||Array.isArray(e)||"[object Object]"===Object.prototype.toString.call(e)}function r(e,n){if(e===n)return e;for(var i in n)if(Object.prototype.hasOwnProperty.call(n,i)&&"__proto__"!==i&&"constructor"!==i){var s=n[i],a=e[i];void 0!==a&&void 0===s||(t(a)&&t(s)?e[i]=r(a,s):e[i]="object"==typeof(c=s)&&null!==c?r(Array.isArray(c)?[]:{},c):c)}var c;return e}e.exports=function(e){t(e)||(e={});for(var n=1,i=arguments.length;n{"use strict";e.exports=function(e){return e&&Object.keys(e).length>0}},1383:e=>{"use strict";e.exports=function(e,t){if(null===e)return{};var r,n,i={},s=Object.keys(e);for(n=0;n=0||(i[r]=e[r]);return i}},8601:e=>{"use strict";function t(e,t){if(e!==t){var r=void 0!==e,n=null===e,i=void 0!==t,s=null===t;if(!s&&e>t||n&&i||!r)return 1;if(!n&&e=n.length?s:"desc"===n[i]?-s:s}return e.index-r.index})),i.map((function(e){return e.value}))}},7507:e=>{"use strict";e.exports=function e(t){if("number"==typeof t)return t;if("string"==typeof t)return parseFloat(t);if(Array.isArray(t))return t.map(e);throw new Error("The value should be a number, a parsable string or an array of those.")}},9228:(e,t,r)=>{"use strict";var n=r(4728);function i(e){return Object.keys(e).sort().reduce((function(t,r){return t[r]=e[r],t}),{})}var s={_getQueries:function(e,t){var r=[];return r.push({indexName:e,params:s._getHitsSearchParams(t)}),t.getRefinedDisjunctiveFacets().forEach((function(n){r.push({indexName:e,params:s._getDisjunctiveFacetSearchParams(t,n)})})),t.getRefinedHierarchicalFacets().forEach((function(n){var i=t.getHierarchicalFacetByName(n),a=t.getHierarchicalRefinement(n),c=t._getHierarchicalFacetSeparator(i);if(a.length>0&&a[0].split(c).length>1){var o=a[0].split(c).slice(0,-1).reduce((function(e,t,r){return e.concat({attribute:i.attributes[r],value:0===r?t:[e[e.length-1].value,t].join(c)})}),[]);o.forEach((function(n,a){var c=s._getDisjunctiveFacetSearchParams(t,n.attribute,0===a);function u(e){return i.attributes.some((function(t){return t===e.split(":")[0]}))}var h=(c.facetFilters||[]).reduce((function(e,t){if(Array.isArray(t)){var r=t.filter((function(e){return!u(e)}));r.length>0&&e.push(r)}return"string"!=typeof t||u(t)||e.push(t),e}),[]),f=o[a-1];a>0?c.facetFilters=h.concat(f.attribute+":"+f.value):h.length>0?c.facetFilters=h:delete c.facetFilters,r.push({indexName:e,params:c})}))}})),r},_getHitsSearchParams:function(e){var t=e.facets.concat(e.disjunctiveFacets).concat(s._getHitsHierarchicalFacetsAttributes(e)).sort(),r=s._getFacetFilters(e),a=s._getNumericFilters(e),c=s._getTagFilters(e),o={};return t.length>0&&(o.facets=t.indexOf("*")>-1?["*"]:t),c.length>0&&(o.tagFilters=c),r.length>0&&(o.facetFilters=r),a.length>0&&(o.numericFilters=a),i(n({},e.getQueryParams(),o))},_getDisjunctiveFacetSearchParams:function(e,t,r){var a=s._getFacetFilters(e,t,r),c=s._getNumericFilters(e,t),o=s._getTagFilters(e),u={hitsPerPage:0,page:0,analytics:!1,clickAnalytics:!1};o.length>0&&(u.tagFilters=o);var h=e.getHierarchicalFacetByName(t);return u.facets=h?s._getDisjunctiveHierarchicalFacetAttribute(e,h,r):t,c.length>0&&(u.numericFilters=c),a.length>0&&(u.facetFilters=a),i(n({},e.getQueryParams(),u))},_getNumericFilters:function(e,t){if(e.numericFilters)return e.numericFilters;var r=[];return Object.keys(e.numericRefinements).forEach((function(n){var i=e.numericRefinements[n]||{};Object.keys(i).forEach((function(e){var s=i[e]||[];t!==n&&s.forEach((function(t){if(Array.isArray(t)){var i=t.map((function(t){return n+e+t}));r.push(i)}else r.push(n+e+t)}))}))})),r},_getTagFilters:function(e){return e.tagFilters?e.tagFilters:e.tagRefinements.join(",")},_getFacetFilters:function(e,t,r){var n=[],i=e.facetsRefinements||{};Object.keys(i).sort().forEach((function(e){(i[e]||[]).slice().sort().forEach((function(t){n.push(e+":"+t)}))}));var s=e.facetsExcludes||{};Object.keys(s).sort().forEach((function(e){(s[e]||[]).sort().forEach((function(t){n.push(e+":-"+t)}))}));var a=e.disjunctiveFacetsRefinements||{};Object.keys(a).sort().forEach((function(e){var r=a[e]||[];if(e!==t&&r&&0!==r.length){var i=[];r.slice().sort().forEach((function(t){i.push(e+":"+t)})),n.push(i)}}));var c=e.hierarchicalFacetsRefinements||{};return Object.keys(c).sort().forEach((function(i){var s=(c[i]||[])[0];if(void 0!==s){var a,o,u=e.getHierarchicalFacetByName(i),h=e._getHierarchicalFacetSeparator(u),f=e._getHierarchicalRootPath(u);if(t===i){if(-1===s.indexOf(h)||!f&&!0===r||f&&f.split(h).length===s.split(h).length)return;f?(o=f.split(h).length-1,s=f):(o=s.split(h).length-2,s=s.slice(0,s.lastIndexOf(h))),a=u.attributes[o]}else o=s.split(h).length-1,a=u.attributes[o];a&&n.push([a+":"+s])}})),n},_getHitsHierarchicalFacetsAttributes:function(e){return e.hierarchicalFacets.reduce((function(t,r){var n=e.getHierarchicalRefinement(r.name)[0];if(!n)return t.push(r.attributes[0]),t;var i=e._getHierarchicalFacetSeparator(r),s=n.split(i).length,a=r.attributes.slice(0,s+1);return t.concat(a)}),[])},_getDisjunctiveHierarchicalFacetAttribute:function(e,t,r){var n=e._getHierarchicalFacetSeparator(t);if(!0===r){var i=e._getHierarchicalRootPath(t),s=0;return i&&(s=i.split(n).length),[t.attributes[s]]}var a=(e.getHierarchicalRefinement(t.name)[0]||"").split(n).length-1;return t.attributes.slice(0,a+1)},getSearchForFacetQuery:function(e,t,r,a){var c=a.isDisjunctiveFacet(e)?a.clearRefinements(e):a,o={facetQuery:t,facetName:e};return"number"==typeof r&&(o.maxFacetHits=r),i(n({},s._getHitsSearchParams(c),o))}};e.exports=s},2208:e=>{"use strict";e.exports=function(e){return null!==e&&/^[a-zA-Z0-9_-]{1,64}$/.test(e)}},7749:(e,t,r)=>{"use strict";var n=r(849),i=r(8657);e.exports=function(e){var t={};return e.forEach((function(e){e.forEach((function(e,r){t[e.objectID]?t[e.objectID]={indexSum:t[e.objectID].indexSum+r,count:t[e.objectID].count+1}:t[e.objectID]={indexSum:r,count:1}}))})),function(e,t){var r=[];return Object.keys(e).forEach((function(n){e[n].count<2&&(e[n].indexSum+=100),r.push({objectID:n,avgOfIndices:e[n].indexSum/t})})),r.sort((function(e,t){return e.avgOfIndices>t.avgOfIndices?1:-1}))}(t,e.length).reduce((function(t,r){var s=n(i(e),(function(e){return e.objectID===r.objectID}));return s?t.concat(s):t}),[])}},6938:e=>{"use strict";e.exports="3.22.5"},3643:function(e){e.exports=function(){"use strict";function e(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function t(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function r(r){for(var n=1;n=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}function i(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){if(Symbol.iterator in Object(e)||"[object Arguments]"===Object.prototype.toString.call(e)){var r=[],n=!0,i=!1,s=void 0;try{for(var a,c=e[Symbol.iterator]();!(n=(a=c.next()).done)&&(r.push(a.value),!t||r.length!==t);n=!0);}catch(e){i=!0,s=e}finally{try{n||null==c.return||c.return()}finally{if(i)throw s}}return r}}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance")}()}function s(e){return function(e){if(Array.isArray(e)){for(var t=0,r=new Array(e.length);t2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return Promise.resolve().then((function(){c();var t=JSON.stringify(e);return s()[t]})).then((function(e){return Promise.all([e?e.value:t(),void 0!==e])})).then((function(e){var t=i(e,2),n=t[0],s=t[1];return Promise.all([n,s||r.miss(n)])})).then((function(e){return i(e,1)[0]}))},set:function(e,t){return Promise.resolve().then((function(){var i=s();return i[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},n().setItem(r,JSON.stringify(i)),t}))},delete:function(e){return Promise.resolve().then((function(){var t=s();delete t[JSON.stringify(e)],n().setItem(r,JSON.stringify(t))}))},clear:function(){return Promise.resolve().then((function(){n().removeItem(r)}))}}}function c(e){var t=s(e.caches),r=t.shift();return void 0===r?{get:function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return t().then((function(e){return Promise.all([e,r.miss(e)])})).then((function(e){return i(e,1)[0]}))},set:function(e,t){return Promise.resolve(t)},delete:function(e){return Promise.resolve()},clear:function(){return Promise.resolve()}}:{get:function(e,n){var i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return r.get(e,n,i).catch((function(){return c({caches:t}).get(e,n,i)}))},set:function(e,n){return r.set(e,n).catch((function(){return c({caches:t}).set(e,n)}))},delete:function(e){return r.delete(e).catch((function(){return c({caches:t}).delete(e)}))},clear:function(){return r.clear().catch((function(){return c({caches:t}).clear()}))}}}function o(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{serializable:!0},t={};return{get:function(r,n){var i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}},s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);var a=n(),c=i&&i.miss||function(){return Promise.resolve()};return a.then((function(e){return c(e)})).then((function(){return a}))},set:function(r,n){return t[JSON.stringify(r)]=e.serializable?JSON.stringify(n):n,Promise.resolve(n)},delete:function(e){return delete t[JSON.stringify(e)],Promise.resolve()},clear:function(){return t={},Promise.resolve()}}}function u(e){for(var t=e.length-1;t>0;t--){var r=Math.floor(Math.random()*(t+1)),n=e[t];e[t]=e[r],e[r]=n}return e}function h(e,t){return t?(Object.keys(t).forEach((function(r){e[r]=t[r](e)})),e):e}function f(e){for(var t=arguments.length,r=new Array(t>1?t-1:0),n=1;n0?n:void 0,timeout:r.timeout||t,headers:r.headers||{},queryParameters:r.queryParameters||{},cacheable:r.cacheable}}var d={Read:1,Write:2,Any:3},p=1,g=2,v=3;function y(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:p;return r(r({},e),{},{status:t,lastUpdate:Date.now()})}function R(e){return"string"==typeof e?{protocol:"https",url:e,accept:d.Any}:{protocol:e.protocol||"https",url:e.url,accept:e.accept||d.Any}}var F="GET",b="POST";function j(e,t){return Promise.all(t.map((function(t){return e.get(t,(function(){return Promise.resolve(y(t))}))}))).then((function(e){var r=e.filter((function(e){return function(e){return e.status===p||Date.now()-e.lastUpdate>12e4}(e)})),n=e.filter((function(e){return function(e){return e.status===v&&Date.now()-e.lastUpdate<=12e4}(e)})),i=[].concat(s(r),s(n));return{getTimeout:function(e,t){return(0===n.length&&0===e?1:n.length+3+e)*t},statelessHosts:i.length>0?i.map((function(e){return R(e)})):t}}))}function P(e,t,n,i){var a=[],c=function(e,t){if(e.method!==F&&(void 0!==e.data||void 0!==t.data)){var n=Array.isArray(e.data)?e.data:r(r({},e.data),t.data);return JSON.stringify(n)}}(n,i),o=function(e,t){var n=r(r({},e.headers),t.headers),i={};return Object.keys(n).forEach((function(e){var t=n[e];i[e.toLowerCase()]=t})),i}(e,i),u=n.method,h=n.method!==F?{}:r(r({},n.data),i.data),f=r(r(r({"x-algolia-agent":e.userAgent.value},e.queryParameters),h),i.queryParameters),l=0,m=function t(r,s){var h=r.pop();if(void 0===h)throw{name:"RetryError",message:"Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support .",transporterStackTrace:O(a)};var m={data:c,headers:o,method:u,url:x(h,n.path,f),connectTimeout:s(l,e.timeouts.connect),responseTimeout:s(l,i.timeout)},d=function(e){var t={request:m,response:e,host:h,triesLeft:r.length};return a.push(t),t},p={onSuccess:function(e){return function(e){try{return JSON.parse(e.content)}catch(t){throw function(e,t){return{name:"DeserializationError",message:e,response:t}}(t.message,e)}}(e)},onRetry:function(n){var i=d(n);return n.isTimedOut&&l++,Promise.all([e.logger.info("Retryable failure",w(i)),e.hostsCache.set(h,y(h,n.isTimedOut?v:g))]).then((function(){return t(r,s)}))},onFail:function(e){throw d(e),function(e,t){var r=e.content,n=e.status,i=r;try{i=JSON.parse(r).message}catch(e){}return function(e,t,r){return{name:"ApiError",message:e,status:t,transporterStackTrace:r}}(i,n,t)}(e,O(a))}};return e.requester.send(m).then((function(e){return function(e,t){return function(e){var t=e.status;return e.isTimedOut||function(e){var t=e.isTimedOut,r=e.status;return!t&&!~~r}(e)||2!=~~(t/100)&&4!=~~(t/100)}(e)?t.onRetry(e):2==~~(e.status/100)?t.onSuccess(e):t.onFail(e)}(e,p)}))};return j(e.hostsCache,t).then((function(e){return m(s(e.statelessHosts).reverse(),e.getTimeout)}))}function _(e){var t={value:"Algolia for JavaScript (".concat(e,")"),add:function(e){var r="; ".concat(e.segment).concat(void 0!==e.version?" (".concat(e.version,")"):"");return-1===t.value.indexOf(r)&&(t.value="".concat(t.value).concat(r)),t}};return t}function x(e,t,r){var n=E(r),i="".concat(e.protocol,"://").concat(e.url,"/").concat("/"===t.charAt(0)?t.substr(1):t);return n.length&&(i+="?".concat(n)),i}function E(e){return Object.keys(e).map((function(t){return f("%s=%s",t,(r=e[t],"[object Object]"===Object.prototype.toString.call(r)||"[object Array]"===Object.prototype.toString.call(r)?JSON.stringify(e[t]):e[t]));var r})).join("&")}function O(e){return e.map((function(e){return w(e)}))}function w(e){var t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return r(r({},e),{},{request:r(r({},e.request),{},{headers:r(r({},e.request.headers),t)})})}var S=function(e){var t=e.appId,n=function(e,t,r){var n={"x-algolia-api-key":r,"x-algolia-application-id":t};return{headers:function(){return e===l.WithinHeaders?n:{}},queryParameters:function(){return e===l.WithinQueryParameters?n:{}}}}(void 0!==e.authMode?e.authMode:l.WithinHeaders,t,e.apiKey),s=function(e){var t=e.hostsCache,r=e.logger,n=e.requester,s=e.requestsCache,a=e.responsesCache,c=e.timeouts,o=e.userAgent,u=e.hosts,h=e.queryParameters,f={hostsCache:t,logger:r,requester:n,requestsCache:s,responsesCache:a,timeouts:c,userAgent:o,headers:e.headers,queryParameters:h,hosts:u.map((function(e){return R(e)})),read:function(e,t){var r=m(t,f.timeouts.read),n=function(){return P(f,f.hosts.filter((function(e){return!!(e.accept&d.Read)})),e,r)};if(!0!==(void 0!==r.cacheable?r.cacheable:e.cacheable))return n();var s={request:e,mappedRequestOptions:r,transporter:{queryParameters:f.queryParameters,headers:f.headers}};return f.responsesCache.get(s,(function(){return f.requestsCache.get(s,(function(){return f.requestsCache.set(s,n()).then((function(e){return Promise.all([f.requestsCache.delete(s),e])}),(function(e){return Promise.all([f.requestsCache.delete(s),Promise.reject(e)])})).then((function(e){var t=i(e,2);return t[0],t[1]}))}))}),{miss:function(e){return f.responsesCache.set(s,e)}})},write:function(e,t){return P(f,f.hosts.filter((function(e){return!!(e.accept&d.Write)})),e,m(t,f.timeouts.write))}};return f}(r(r({hosts:[{url:"".concat(t,"-dsn.algolia.net"),accept:d.Read},{url:"".concat(t,".algolia.net"),accept:d.Write}].concat(u([{url:"".concat(t,"-1.algolianet.com")},{url:"".concat(t,"-2.algolianet.com")},{url:"".concat(t,"-3.algolianet.com")}]))},e),{},{headers:r(r(r({},n.headers()),{"content-type":"application/x-www-form-urlencoded"}),e.headers),queryParameters:r(r({},n.queryParameters()),e.queryParameters)}));return h({transporter:s,appId:t,addAlgoliaAgent:function(e,t){s.userAgent.add({segment:e,version:t})},clearCache:function(){return Promise.all([s.requestsCache.clear(),s.responsesCache.clear()]).then((function(){}))}},e.methods)},A=function(e){return function(t,r){return t.method===F?e.transporter.read(t,r):e.transporter.write(t,r)}},N=function(e){return function(t){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return h({transporter:e.transporter,appId:e.appId,indexName:t},r.methods)}},T=function(e){return function(t,n){var i=t.map((function(e){return r(r({},e),{},{params:E(e.params||{})})}));return e.transporter.read({method:b,path:"1/indexes/*/queries",data:{requests:i},cacheable:!0},n)}},H=function(e){return function(t,i){return Promise.all(t.map((function(t){var s=t.params,a=s.facetName,c=s.facetQuery,o=n(s,["facetName","facetQuery"]);return N(e)(t.indexName,{methods:{searchForFacetValues:I}}).searchForFacetValues(a,c,r(r({},i),o))})))}},Q=function(e){return function(t,r,n){return e.transporter.read({method:b,path:f("1/answers/%s/prediction",e.indexName),data:{query:t,queryLanguages:r},cacheable:!0},n)}},C=function(e){return function(t,r){return e.transporter.read({method:b,path:f("1/indexes/%s/query",e.indexName),data:{query:t},cacheable:!0},r)}},I=function(e){return function(t,r,n){return e.transporter.read({method:b,path:f("1/indexes/%s/facets/%s/query",e.indexName,t),data:{facetQuery:r},cacheable:!0},n)}},D=1,k=2,q=3,L=function(e){return function(t,n){var i=t.map((function(e){return r(r({},e),{},{threshold:e.threshold||0})}));return e.transporter.read({method:b,path:"1/indexes/*/recommendations",data:{requests:i},cacheable:!0},n)}};function V(e,t,n){var i,s={appId:e,apiKey:t,timeouts:{connect:1,read:2,write:30},requester:{send:function(e){return new Promise((function(t){var r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((function(t){return r.setRequestHeader(t,e.headers[t])}));var n,i=function(e,n){return setTimeout((function(){r.abort(),t({status:0,content:n,isTimedOut:!0})}),1e3*e)},s=i(e.connectTimeout,"Connection timeout");r.onreadystatechange=function(){r.readyState>r.OPENED&&void 0===n&&(clearTimeout(s),n=i(e.responseTimeout,"Socket timeout"))},r.onerror=function(){0===r.status&&(clearTimeout(s),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=function(){clearTimeout(s),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},logger:(i=q,{debug:function(e,t){return D>=i&&console.debug(e,t),Promise.resolve()},info:function(e,t){return k>=i&&console.info(e,t),Promise.resolve()},error:function(e,t){return console.error(e,t),Promise.resolve()}}),responsesCache:o(),requestsCache:o({serializable:!1}),hostsCache:c({caches:[a({key:"".concat("4.24.0","-").concat(e)}),o()]}),userAgent:_("4.24.0").add({segment:"Browser",version:"lite"}),authMode:l.WithinQueryParameters};return S(r(r(r({},s),n),{},{methods:{search:T,searchForFacetValues:H,multipleQueries:T,multipleSearchForFacetValues:H,customRequest:A,initIndex:function(e){return function(t){return N(e)(t,{methods:{search:C,searchForFacetValues:I,findAnswers:Q}})}},getRecommendations:L}}))}return V.version="4.24.0",V}()},5846:(e,t,r)=>{"use strict";r.d(t,{W:()=>u});var n=r(6540),i=r(4586);const s=["zero","one","two","few","many","other"];function a(e){return s.filter((t=>e.includes(t)))}const c={locale:"en",pluralForms:a(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,i.A)();return(0,n.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:a(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),c}}),[e])}function u(){const e=o();return{selectMessage:(t,r)=>function(e,t,r){const n=e.split("|");if(1===n.length)return n[0];n.length>r.pluralForms.length&&console.error(`For locale=${r.locale}, a maximum of ${r.pluralForms.length} plural forms are expected (${r.pluralForms.join(",")}), but the message contains ${n.length}: ${e}`);const i=r.select(t),s=r.pluralForms.indexOf(i);return n[Math.min(s,n.length-1)]}(r,t,e)}}},4604:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>w});var n=r(6540),i=r(4164),s=r(4103),a=r.n(s),c=r(3643),o=r.n(c),u=r(8193),h=r(5260),f=r(8774),l=r(4070),m=r(5846),d=r(4255),p=r(9532),g=r(5500),v=r(481),y=r(1312),R=r(4586),F=r(8126),b=r(1062),j=r(3277),P=r(1107);const _={searchQueryInput:"searchQueryInput_u2C7",searchVersionInput:"searchVersionInput_m0Ui",searchResultsColumn:"searchResultsColumn_JPFH",algoliaLogo:"algoliaLogo_rT1R",algoliaLogoPathFill:"algoliaLogoPathFill_WdUC",searchResultItem:"searchResultItem_Tv2o",searchResultItemHeading:"searchResultItemHeading_KbCB",searchResultItemPath:"searchResultItemPath_lhe1",searchResultItemSummary:"searchResultItemSummary_AEaO",searchQueryColumn:"searchQueryColumn_RTkw",searchVersionColumn:"searchVersionColumn_ypXd",searchLogoColumn:"searchLogoColumn_rJIA",loadingSpinner:"loadingSpinner_XVxU","loading-spin":"loading-spin_vzvp",loader:"loader_vvXV"};var x=r(4848);function E(e){let{docsSearchVersionsHelpers:t}=e;const r=Object.entries(t.allDocsData).filter((e=>{let[,t]=e;return t.versions.length>1}));return(0,x.jsx)("div",{className:(0,i.A)("col","col--3","padding-left--none",_.searchVersionColumn),children:r.map((e=>{let[n,i]=e;const s=r.length>1?`${n}: `:"";return(0,x.jsx)("select",{onChange:e=>t.setSearchVersion(n,e.target.value),defaultValue:t.searchVersions[n],className:_.searchVersionInput,children:i.versions.map(((e,t)=>(0,x.jsx)("option",{label:`${s}${e.label}`,value:e.name},t)))},n)}))})}function O(){const{i18n:{currentLocale:e}}=(0,R.A)(),{algolia:{appId:t,apiKey:r,indexName:s,contextualSearch:c}}=(0,F.c)(),g=(0,b.C)(),O=function(){const{selectMessage:e}=(0,m.W)();return t=>e(t,(0,y.T)({id:"theme.SearchPage.documentsFound.plurals",description:'Pluralized label for "{count} documents found". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One document found|{count} documents found"},{count:t}))}(),w=function(){const e=(0,l.Gy)(),[t,r]=(0,n.useState)((()=>Object.entries(e).reduce(((e,t)=>{let[r,n]=t;return{...e,[r]:n.versions[0].name}}),{}))),i=Object.values(e).some((e=>e.versions.length>1));return{allDocsData:e,versioningEnabled:i,searchVersions:t,setSearchVersion:(e,t)=>r((r=>({...r,[e]:t})))}}(),[S,A]=(0,d.b)(),N={items:[],query:null,totalResults:null,totalPages:null,lastPage:null,hasMore:null,loading:null},[T,H]=(0,n.useReducer)(((e,t)=>{switch(t.type){case"reset":return N;case"loading":return{...e,loading:!0};case"update":return S!==t.value.query?e:{...t.value,items:0===t.value.lastPage?t.value.items:e.items.concat(t.value.items)};case"advance":{const t=e.totalPages>e.lastPage+1;return{...e,lastPage:t?e.lastPage+1:e.lastPage,hasMore:t}}default:return e}}),N),Q=c?["language","docusaurus_tag"]:[],C=o()(t,r),I=a()(C,s,{hitsPerPage:15,advancedSyntax:!0,disjunctiveFacets:Q});I.on("result",(e=>{let{results:{query:t,hits:r,page:n,nbHits:i,nbPages:s}}=e;if(""===t||!Array.isArray(r))return void H({type:"reset"});const a=e=>e.replace(/algolia-docsearch-suggestion--highlight/g,"search-result-match"),c=r.map((e=>{let{url:t,_highlightResult:{hierarchy:r},_snippetResult:n={}}=e;const i=Object.keys(r).map((e=>a(r[e].value)));return{title:i.pop(),url:g(t),summary:n.content?`${a(n.content.value)}...`:"",breadcrumbs:i}}));H({type:"update",value:{items:c,query:t,totalResults:i,totalPages:s,lastPage:n,hasMore:s>n+1,loading:!1}})}));const[D,k]=(0,n.useState)(null),q=(0,n.useRef)(0),L=(0,n.useRef)(u.A.canUseIntersectionObserver&&new IntersectionObserver((e=>{const{isIntersecting:t,boundingClientRect:{y:r}}=e[0];t&&q.current>r&&H({type:"advance"}),q.current=r}),{threshold:1})),V=()=>S?(0,y.T)({id:"theme.SearchPage.existingResultsTitle",message:'Search results for "{query}"',description:"The search page title for non-empty query"},{query:S}):(0,y.T)({id:"theme.SearchPage.emptyResultsTitle",message:"Search the documentation",description:"The search page title for empty query"}),B=(0,p._q)((function(t){void 0===t&&(t=0),c&&(I.addDisjunctiveFacetRefinement("docusaurus_tag","default"),I.addDisjunctiveFacetRefinement("language",e),Object.entries(w.searchVersions).forEach((e=>{let[t,r]=e;I.addDisjunctiveFacetRefinement("docusaurus_tag",`docs-${t}-${r}`)}))),I.setQuery(S).setPage(t).search()}));return(0,n.useEffect)((()=>{if(!D)return;const e=L.current;return e?(e.observe(D),()=>e.unobserve(D)):()=>!0}),[D]),(0,n.useEffect)((()=>{H({type:"reset"}),S&&(H({type:"loading"}),setTimeout((()=>{B()}),300))}),[S,w.searchVersions,B]),(0,n.useEffect)((()=>{T.lastPage&&0!==T.lastPage&&B(T.lastPage)}),[B,T.lastPage]),(0,x.jsxs)(j.A,{children:[(0,x.jsxs)(h.A,{children:[(0,x.jsx)("title",{children:(0,v.s)(V())}),(0,x.jsx)("meta",{property:"robots",content:"noindex, follow"})]}),(0,x.jsxs)("div",{className:"container margin-vert--lg",children:[(0,x.jsx)(P.A,{as:"h1",children:V()}),(0,x.jsxs)("form",{className:"row",onSubmit:e=>e.preventDefault(),children:[(0,x.jsx)("div",{className:(0,i.A)("col",_.searchQueryColumn,{"col--9":w.versioningEnabled,"col--12":!w.versioningEnabled}),children:(0,x.jsx)("input",{type:"search",name:"q",className:_.searchQueryInput,placeholder:(0,y.T)({id:"theme.SearchPage.inputPlaceholder",message:"Type your search here",description:"The placeholder for search page input"}),"aria-label":(0,y.T)({id:"theme.SearchPage.inputLabel",message:"Search",description:"The ARIA label for search page input"}),onChange:e=>A(e.target.value),value:S,autoComplete:"off",autoFocus:!0})}),c&&w.versioningEnabled&&(0,x.jsx)(E,{docsSearchVersionsHelpers:w})]}),(0,x.jsxs)("div",{className:"row",children:[(0,x.jsx)("div",{className:(0,i.A)("col","col--8",_.searchResultsColumn),children:!!T.totalResults&&O(T.totalResults)}),(0,x.jsx)("div",{className:(0,i.A)("col","col--4","text--right",_.searchLogoColumn),children:(0,x.jsx)(f.A,{to:"https://www.algolia.com/","aria-label":(0,y.T)({id:"theme.SearchPage.algoliaLabel",message:"Search by Algolia",description:"The ARIA label for Algolia mention"}),children:(0,x.jsx)("svg",{viewBox:"0 0 168 24",className:_.algoliaLogo,children:(0,x.jsxs)("g",{fill:"none",children:[(0,x.jsx)("path",{className:_.algoliaLogoPathFill,d:"M120.925 18.804c-4.386.02-4.386-3.54-4.386-4.106l-.007-13.336 2.675-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-10.846-2.18c.821 0 1.43-.047 1.855-.129v-2.719a6.334 6.334 0 0 0-1.574-.199 5.7 5.7 0 0 0-.897.069 2.699 2.699 0 0 0-.814.24c-.24.116-.439.28-.582.491-.15.212-.219.335-.219.656 0 .628.219.991.616 1.23s.938.362 1.615.362zm-.233-9.7c.883 0 1.629.109 2.231.328.602.218 1.088.525 1.444.915.363.396.609.922.76 1.483.157.56.232 1.175.232 1.85v6.874a32.5 32.5 0 0 1-1.868.314c-.834.123-1.772.185-2.813.185-.69 0-1.327-.069-1.895-.198a4.001 4.001 0 0 1-1.471-.636 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.803 0-.656.13-1.073.384-1.525a3.24 3.24 0 0 1 1.047-1.106c.445-.287.95-.492 1.532-.615a8.8 8.8 0 0 1 1.82-.185 8.404 8.404 0 0 1 1.972.24v-.438c0-.307-.035-.6-.11-.874a1.88 1.88 0 0 0-.384-.73 1.784 1.784 0 0 0-.724-.493 3.164 3.164 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.735 7.735 0 0 0-1.26.307l-.321-2.192c.335-.117.834-.233 1.478-.349a10.98 10.98 0 0 1 2.073-.178zm52.842 9.626c.822 0 1.43-.048 1.854-.13V13.7a6.347 6.347 0 0 0-1.574-.199c-.294 0-.595.021-.896.069a2.7 2.7 0 0 0-.814.24 1.46 1.46 0 0 0-.582.491c-.15.212-.218.335-.218.656 0 .628.218.991.615 1.23.404.245.938.362 1.615.362zm-.226-9.694c.883 0 1.629.108 2.231.327.602.219 1.088.526 1.444.915.355.39.609.923.759 1.483a6.8 6.8 0 0 1 .233 1.852v6.873c-.41.088-1.034.19-1.868.314-.834.123-1.772.184-2.813.184-.69 0-1.327-.068-1.895-.198a4.001 4.001 0 0 1-1.471-.635 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.804 0-.656.13-1.073.384-1.524.26-.45.608-.82 1.047-1.107.445-.286.95-.491 1.532-.614a8.803 8.803 0 0 1 2.751-.13c.329.034.671.096 1.04.185v-.437a3.3 3.3 0 0 0-.109-.875 1.873 1.873 0 0 0-.384-.731 1.784 1.784 0 0 0-.724-.492 3.165 3.165 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.75 7.75 0 0 0-1.26.307l-.321-2.193c.335-.116.834-.232 1.478-.348a11.633 11.633 0 0 1 2.073-.177zm-8.034-1.271a1.626 1.626 0 0 1-1.628-1.62c0-.895.725-1.62 1.628-1.62.904 0 1.63.725 1.63 1.62 0 .895-.733 1.62-1.63 1.62zm1.348 13.22h-2.689V7.27l2.69-.423v11.956zm-4.714 0c-4.386.02-4.386-3.54-4.386-4.107l-.008-13.336 2.676-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-8.698-5.903c0-1.156-.253-2.119-.746-2.788-.493-.677-1.183-1.01-2.067-1.01-.882 0-1.574.333-2.065 1.01-.493.676-.733 1.632-.733 2.788 0 1.168.246 1.953.74 2.63.492.683 1.183 1.018 2.066 1.018.882 0 1.574-.342 2.067-1.019.492-.683.738-1.46.738-2.63zm2.737-.007c0 .902-.13 1.584-.397 2.33a5.52 5.52 0 0 1-1.128 1.906 4.986 4.986 0 0 1-1.752 1.223c-.685.286-1.739.45-2.265.45-.528-.006-1.574-.157-2.252-.45a5.096 5.096 0 0 1-1.744-1.223c-.487-.527-.863-1.162-1.137-1.906a6.345 6.345 0 0 1-.41-2.33c0-.902.123-1.77.397-2.508a5.554 5.554 0 0 1 1.15-1.892 5.133 5.133 0 0 1 1.75-1.216c.679-.287 1.425-.423 2.232-.423.808 0 1.553.142 2.237.423a4.88 4.88 0 0 1 1.753 1.216 5.644 5.644 0 0 1 1.135 1.892c.287.738.431 1.606.431 2.508zm-20.138 0c0 1.12.246 2.363.738 2.882.493.52 1.13.78 1.91.78.424 0 .828-.062 1.204-.178.377-.116.677-.253.917-.417V9.33a10.476 10.476 0 0 0-1.766-.226c-.971-.028-1.71.37-2.23 1.004-.513.636-.773 1.75-.773 2.788zm7.438 5.274c0 1.824-.466 3.156-1.404 4.004-.936.846-2.367 1.27-4.296 1.27-.705 0-2.17-.137-3.34-.396l.431-2.118c.98.205 2.272.26 2.95.26 1.074 0 1.84-.219 2.299-.656.459-.437.684-1.086.684-1.948v-.437a8.07 8.07 0 0 1-1.047.397c-.43.13-.93.198-1.492.198-.739 0-1.41-.116-2.018-.349a4.206 4.206 0 0 1-1.567-1.025c-.431-.45-.774-1.017-1.013-1.694-.24-.677-.363-1.885-.363-2.773 0-.834.13-1.88.384-2.577.26-.696.629-1.298 1.129-1.796.493-.498 1.095-.881 1.8-1.162a6.605 6.605 0 0 1 2.428-.457c.87 0 1.67.109 2.45.24.78.129 1.444.265 1.985.415V18.17zM6.972 6.677v1.627c-.712-.446-1.52-.67-2.425-.67-.585 0-1.045.13-1.38.391a1.24 1.24 0 0 0-.502 1.03c0 .425.164.765.494 1.02.33.256.835.532 1.516.83.447.192.795.356 1.045.495.25.138.537.332.862.582.324.25.563.548.718.894.154.345.23.741.23 1.188 0 .947-.334 1.691-1.004 2.234-.67.542-1.537.814-2.601.814-1.18 0-2.16-.229-2.936-.686v-1.708c.84.628 1.814.942 2.92.942.585 0 1.048-.136 1.388-.407.34-.271.51-.646.51-1.125 0-.287-.1-.55-.302-.79-.203-.24-.42-.42-.655-.542-.234-.123-.585-.29-1.053-.503a61.27 61.27 0 0 1-.582-.271 13.67 13.67 0 0 1-.55-.287 4.275 4.275 0 0 1-.567-.351 6.92 6.92 0 0 1-.455-.4c-.18-.17-.31-.34-.39-.51-.08-.17-.155-.37-.224-.598a2.553 2.553 0 0 1-.104-.742c0-.915.333-1.638.998-2.17.664-.532 1.523-.798 2.576-.798.968 0 1.793.17 2.473.51zm7.468 5.696v-.287c-.022-.607-.187-1.088-.495-1.444-.309-.357-.75-.535-1.324-.535-.532 0-.99.194-1.373.583-.382.388-.622.949-.717 1.683h3.909zm1.005 2.792v1.404c-.596.34-1.383.51-2.362.51-1.255 0-2.255-.377-3-1.132-.744-.755-1.116-1.744-1.116-2.968 0-1.297.34-2.316 1.021-3.055.68-.74 1.548-1.11 2.6-1.11 1.033 0 1.852.323 2.458.966.606.644.91 1.572.91 2.784 0 .33-.033.676-.096 1.038h-5.314c.107.702.405 1.239.894 1.611.49.372 1.106.558 1.85.558.862 0 1.58-.202 2.155-.606zm6.605-1.77h-1.212c-.596 0-1.045.116-1.349.35-.303.234-.454.532-.454.894 0 .372.117.664.35.877.235.213.575.32 1.022.32.51 0 .912-.142 1.204-.424.293-.281.44-.651.44-1.108v-.91zm-4.068-2.554V9.325c.627-.361 1.457-.542 2.489-.542 2.116 0 3.175 1.026 3.175 3.08V17h-1.548v-.957c-.415.68-1.143 1.02-2.186 1.02-.766 0-1.38-.22-1.843-.661-.462-.442-.694-1.003-.694-1.684 0-.776.293-1.38.878-1.81.585-.431 1.404-.647 2.457-.647h1.34V11.8c0-.554-.133-.971-.399-1.253-.266-.282-.707-.423-1.324-.423a4.07 4.07 0 0 0-2.345.718zm9.333-1.93v1.42c.394-1 1.101-1.5 2.123-1.5.148 0 .313.016.494.048v1.531a1.885 1.885 0 0 0-.75-.143c-.542 0-.989.24-1.34.718-.351.479-.527 1.048-.527 1.707V17h-1.563V8.91h1.563zm5.01 4.084c.022.82.272 1.492.75 2.019.479.526 1.15.79 2.01.79.639 0 1.235-.176 1.788-.527v1.404c-.521.319-1.186.479-1.995.479-1.265 0-2.276-.4-3.031-1.197-.755-.798-1.133-1.792-1.133-2.984 0-1.16.38-2.151 1.14-2.975.761-.825 1.79-1.237 3.088-1.237.702 0 1.346.149 1.93.447v1.436a3.242 3.242 0 0 0-1.77-.495c-.84 0-1.513.266-2.019.798-.505.532-.758 1.213-.758 2.042zM40.24 5.72v4.579c.458-1 1.293-1.5 2.505-1.5.787 0 1.42.245 1.899.734.479.49.718 1.17.718 2.042V17h-1.564v-5.106c0-.553-.14-.98-.422-1.284-.282-.303-.652-.455-1.11-.455-.531 0-1.002.202-1.411.606-.41.405-.615 1.022-.615 1.851V17h-1.563V5.72h1.563zm14.966 10.02c.596 0 1.096-.253 1.5-.758.404-.506.606-1.157.606-1.955 0-.915-.202-1.62-.606-2.114-.404-.495-.92-.742-1.548-.742-.553 0-1.05.224-1.491.67-.442.447-.662 1.133-.662 2.058 0 .958.212 1.67.638 2.138.425.469.946.703 1.563.703zM53.004 5.72v4.42c.574-.894 1.388-1.341 2.44-1.341 1.022 0 1.857.383 2.506 1.149.649.766.973 1.781.973 3.047 0 1.138-.309 2.109-.925 2.912-.617.803-1.463 1.205-2.537 1.205-1.075 0-1.894-.447-2.457-1.34V17h-1.58V5.72h1.58zm9.908 11.104l-3.223-7.913h1.739l1.005 2.632 1.26 3.415c.096-.32.48-1.458 1.15-3.415l.909-2.632h1.66l-2.92 7.866c-.777 2.074-1.963 3.11-3.559 3.11a2.92 2.92 0 0 1-.734-.079v-1.34c.17.042.351.064.543.064 1.032 0 1.755-.57 2.17-1.708z"}),(0,x.jsx)("path",{fill:"#5468FF",d:"M78.988.938h16.594a2.968 2.968 0 0 1 2.966 2.966V20.5a2.967 2.967 0 0 1-2.966 2.964H78.988a2.967 2.967 0 0 1-2.966-2.964V3.897A2.961 2.961 0 0 1 78.988.938z"}),(0,x.jsx)("path",{fill:"white",d:"M89.632 5.967v-.772a.978.978 0 0 0-.978-.977h-2.28a.978.978 0 0 0-.978.977v.793c0 .088.082.15.171.13a7.127 7.127 0 0 1 1.984-.28c.65 0 1.295.088 1.917.259.082.02.164-.04.164-.13m-6.248 1.01l-.39-.389a.977.977 0 0 0-1.382 0l-.465.465a.973.973 0 0 0 0 1.38l.383.383c.062.061.15.047.205-.014.226-.307.472-.601.746-.874.281-.28.568-.526.883-.751.068-.042.075-.137.02-.2m4.16 2.453v3.341c0 .096.104.165.192.117l2.97-1.537c.068-.034.089-.117.055-.184a3.695 3.695 0 0 0-3.08-1.866c-.068 0-.136.054-.136.13m0 8.048a4.489 4.489 0 0 1-4.49-4.482 4.488 4.488 0 0 1 4.49-4.482 4.488 4.488 0 0 1 4.489 4.482 4.484 4.484 0 0 1-4.49 4.482m0-10.85a6.363 6.363 0 1 0 0 12.729 6.37 6.37 0 0 0 6.372-6.368 6.358 6.358 0 0 0-6.371-6.36"})]})})})})]}),T.items.length>0?(0,x.jsx)("main",{children:T.items.map(((e,t)=>{let{title:r,url:n,summary:s,breadcrumbs:a}=e;return(0,x.jsxs)("article",{className:_.searchResultItem,children:[(0,x.jsx)(P.A,{as:"h2",className:_.searchResultItemHeading,children:(0,x.jsx)(f.A,{to:n,dangerouslySetInnerHTML:{__html:r}})}),a.length>0&&(0,x.jsx)("nav",{"aria-label":"breadcrumbs",children:(0,x.jsx)("ul",{className:(0,i.A)("breadcrumbs",_.searchResultItemPath),children:a.map(((e,t)=>(0,x.jsx)("li",{className:"breadcrumbs__item",dangerouslySetInnerHTML:{__html:e}},t)))})}),s&&(0,x.jsx)("p",{className:_.searchResultItemSummary,dangerouslySetInnerHTML:{__html:s}})]},t)}))}):[S&&!T.loading&&(0,x.jsx)("p",{children:(0,x.jsx)(y.A,{id:"theme.SearchPage.noResultsText",description:"The paragraph for empty search result",children:"No results were found"})},"no-results"),!!T.loading&&(0,x.jsx)("div",{className:_.loadingSpinner},"spinner")],T.hasMore&&(0,x.jsx)("div",{className:_.loader,ref:k,children:(0,x.jsx)(y.A,{id:"theme.SearchPage.fetchingNewResults",description:"The paragraph for fetching new search results",children:"Fetching new results..."})})]})]})}function w(){return(0,x.jsx)(g.e3,{className:"search-page-wrapper",children:(0,x.jsx)(O,{})})}}}]); \ No newline at end of file diff --git a/assets/js/1a4e3797.82fcdfef.js.LICENSE.txt b/assets/js/1a4e3797.02b74727.js.LICENSE.txt similarity index 100% rename from assets/js/1a4e3797.82fcdfef.js.LICENSE.txt rename to assets/js/1a4e3797.02b74727.js.LICENSE.txt diff --git a/assets/js/1a4e3797.82fcdfef.js b/assets/js/1a4e3797.82fcdfef.js deleted file mode 100644 index e092129aee..0000000000 --- a/assets/js/1a4e3797.82fcdfef.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see 1a4e3797.82fcdfef.js.LICENSE.txt */ -(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2138],{2733:e=>{function t(){this._events=this._events||{},this._maxListeners=this._maxListeners||void 0}function r(e){return"function"==typeof e}function n(e){return"object"==typeof e&&null!==e}function i(e){return void 0===e}e.exports=t,t.prototype._events=void 0,t.prototype._maxListeners=void 0,t.defaultMaxListeners=10,t.prototype.setMaxListeners=function(e){if("number"!=typeof e||e<0||isNaN(e))throw TypeError("n must be a positive number");return this._maxListeners=e,this},t.prototype.emit=function(e){var t,s,a,c,o,u;if(this._events||(this._events={}),"error"===e&&(!this._events.error||n(this._events.error)&&!this._events.error.length)){if((t=arguments[1])instanceof Error)throw t;var h=new Error('Uncaught, unspecified "error" event. ('+t+")");throw h.context=t,h}if(i(s=this._events[e]))return!1;if(r(s))switch(arguments.length){case 1:s.call(this);break;case 2:s.call(this,arguments[1]);break;case 3:s.call(this,arguments[1],arguments[2]);break;default:c=Array.prototype.slice.call(arguments,1),s.apply(this,c)}else if(n(s))for(c=Array.prototype.slice.call(arguments,1),a=(u=s.slice()).length,o=0;o0&&this._events[e].length>a&&(this._events[e].warned=!0,console.error("(node) warning: possible EventEmitter memory leak detected. %d listeners added. Use emitter.setMaxListeners() to increase limit.",this._events[e].length),"function"==typeof console.trace&&console.trace()),this},t.prototype.on=t.prototype.addListener,t.prototype.once=function(e,t){if(!r(t))throw TypeError("listener must be a function");var n=!1;function i(){this.removeListener(e,i),n||(n=!0,t.apply(this,arguments))}return i.listener=t,this.on(e,i),this},t.prototype.removeListener=function(e,t){var i,s,a,c;if(!r(t))throw TypeError("listener must be a function");if(!this._events||!this._events[e])return this;if(a=(i=this._events[e]).length,s=-1,i===t||r(i.listener)&&i.listener===t)delete this._events[e],this._events.removeListener&&this.emit("removeListener",e,t);else if(n(i)){for(c=a;c-- >0;)if(i[c]===t||i[c].listener&&i[c].listener===t){s=c;break}if(s<0)return this;1===i.length?(i.length=0,delete this._events[e]):i.splice(s,1),this._events.removeListener&&this.emit("removeListener",e,t)}return this},t.prototype.removeAllListeners=function(e){var t,n;if(!this._events)return this;if(!this._events.removeListener)return 0===arguments.length?this._events={}:this._events[e]&&delete this._events[e],this;if(0===arguments.length){for(t in this._events)"removeListener"!==t&&this.removeAllListeners(t);return this.removeAllListeners("removeListener"),this._events={},this}if(r(n=this._events[e]))this.removeListener(e,n);else if(n)for(;n.length;)this.removeListener(e,n[n.length-1]);return delete this._events[e],this},t.prototype.listeners=function(e){return this._events&&this._events[e]?r(this._events[e])?[this._events[e]]:this._events[e].slice():[]},t.prototype.listenerCount=function(e){if(this._events){var t=this._events[e];if(r(t))return 1;if(t)return t.length}return 0},t.listenerCount=function(e,t){return e.listenerCount(t)}},4103:(e,t,r)=>{"use strict";var n=r(6571),i=r(9127),s=r(2223),a=r(3371),c=r(7691);function o(e,t,r,i){return new n(e,t,r,i)}o.version=r(6938),o.AlgoliaSearchHelper=n,o.SearchParameters=a,o.RecommendParameters=i,o.SearchResults=c,o.RecommendResults=s,e.exports=o},6732:(e,t,r)=>{"use strict";var n=r(2733);function i(e,t,r){this.main=e,this.fn=t,this.recommendFn=r,this.lastResults=null,this.lastRecommendResults=null}r(3014)(i,n),i.prototype.detach=function(){this.removeAllListeners(),this.main.detachDerivedHelper(this)},i.prototype.getModifiedState=function(e){return this.fn(e)},i.prototype.getModifiedRecommendState=function(e){return this.recommendFn(e)},e.exports=i},9127:e=>{"use strict";function t(e){e=e||{},this.params=e.params||[]}t.prototype={constructor:t,addParams:function(e){var r=this.params.slice();return r.push(e),new t({params:r})},removeParams:function(e){return new t({params:this.params.filter((function(t){return t.$$id!==e}))})},addFrequentlyBoughtTogether:function(e){return this.addParams(Object.assign({},e,{model:"bought-together"}))},addRelatedProducts:function(e){return this.addParams(Object.assign({},e,{model:"related-products"}))},addTrendingItems:function(e){return this.addParams(Object.assign({},e,{model:"trending-items"}))},addTrendingFacets:function(e){return this.addParams(Object.assign({},e,{model:"trending-facets"}))},addLookingSimilar:function(e){return this.addParams(Object.assign({},e,{model:"looking-similar"}))},_buildQueries:function(e,t){return this.params.filter((function(e){return void 0===t[e.$$id]})).map((function(t){var r=Object.assign({},t,{indexName:e,threshold:t.threshold||0});return delete r.$$id,r}))}},e.exports=t},2223:e=>{"use strict";function t(e,t){this._state=e,this._rawResults={};var r=this;e.params.forEach((function(e){var n=e.$$id;r[n]=t[n],r._rawResults[n]=t[n]}))}t.prototype={constructor:t},e.exports=t},1673:(e,t,r)=>{"use strict";var n=r(9110),i=r(317),s=r(1383),a={addRefinement:function(e,t,r){if(a.isRefined(e,t,r))return e;var i=""+r,s=e[t]?e[t].concat(i):[i],c={};return c[t]=s,n({},c,e)},removeRefinement:function(e,t,r){if(void 0===r)return a.clearRefinement(e,(function(e,r){return t===r}));var n=""+r;return a.clearRefinement(e,(function(e,r){return t===r&&n===e}))},toggleRefinement:function(e,t,r){if(void 0===r)throw new Error("toggleRefinement should be used with a value");return a.isRefined(e,t,r)?a.removeRefinement(e,t,r):a.addRefinement(e,t,r)},clearRefinement:function(e,t,r){if(void 0===t)return i(e)?{}:e;if("string"==typeof t)return s(e,[t]);if("function"==typeof t){var n=!1,a=Object.keys(e).reduce((function(i,s){var a=e[s]||[],c=a.filter((function(e){return!t(e,s,r)}));return c.length!==a.length&&(n=!0),i[s]=c,i}),{});return n?a:e}},isRefined:function(e,t,r){var n=Boolean(e[t])&&e[t].length>0;if(void 0===r||!n)return n;var i=""+r;return-1!==e[t].indexOf(i)}};e.exports=a},3371:(e,t,r)=>{"use strict";var n=r(9110),i=r(849),s=r(4843),a=r(4728),c=r(317),o=r(1383),u=r(7507),h=r(2208),f=r(1673);function l(e,t){return Array.isArray(e)&&Array.isArray(t)?e.length===t.length&&e.every((function(e,r){return l(t[r],e)})):e===t}function m(e){var t=e?m._parseNumbers(e):{};void 0===t.userToken||h(t.userToken)||console.warn("[algoliasearch-helper] The `userToken` parameter is invalid. This can lead to wrong analytics.\n - Format: [a-zA-Z0-9_-]{1,64}"),this.facets=t.facets||[],this.disjunctiveFacets=t.disjunctiveFacets||[],this.hierarchicalFacets=t.hierarchicalFacets||[],this.facetsRefinements=t.facetsRefinements||{},this.facetsExcludes=t.facetsExcludes||{},this.disjunctiveFacetsRefinements=t.disjunctiveFacetsRefinements||{},this.numericRefinements=t.numericRefinements||{},this.tagRefinements=t.tagRefinements||[],this.hierarchicalFacetsRefinements=t.hierarchicalFacetsRefinements||{};var r=this;Object.keys(t).forEach((function(e){var n=-1!==m.PARAMETERS.indexOf(e),i=void 0!==t[e];!n&&i&&(r[e]=t[e])}))}m.PARAMETERS=Object.keys(new m),m._parseNumbers=function(e){if(e instanceof m)return e;var t={};if(["aroundPrecision","aroundRadius","getRankingInfo","minWordSizefor2Typos","minWordSizefor1Typo","page","maxValuesPerFacet","distinct","minimumAroundRadius","hitsPerPage","minProximity"].forEach((function(r){var n=e[r];if("string"==typeof n){var i=parseFloat(n);t[r]=isNaN(i)?n:i}})),Array.isArray(e.insideBoundingBox)&&(t.insideBoundingBox=e.insideBoundingBox.map((function(e){return Array.isArray(e)?e.map((function(e){return parseFloat(e)})):e}))),e.numericRefinements){var r={};Object.keys(e.numericRefinements).forEach((function(t){var n=e.numericRefinements[t]||{};r[t]={},Object.keys(n).forEach((function(e){var i=n[e].map((function(e){return Array.isArray(e)?e.map((function(e){return"string"==typeof e?parseFloat(e):e})):"string"==typeof e?parseFloat(e):e}));r[t][e]=i}))})),t.numericRefinements=r}return a(e,t)},m.make=function(e){var t=new m(e);return(e.hierarchicalFacets||[]).forEach((function(e){if(e.rootPath){var r=t.getHierarchicalRefinement(e.name);r.length>0&&0!==r[0].indexOf(e.rootPath)&&(t=t.clearRefinements(e.name)),0===(r=t.getHierarchicalRefinement(e.name)).length&&(t=t.toggleHierarchicalFacetRefinement(e.name,e.rootPath))}})),t},m.validate=function(e,t){var r=t||{};return e.tagFilters&&r.tagRefinements&&r.tagRefinements.length>0?new Error("[Tags] Cannot switch from the managed tag API to the advanced API. It is probably an error, if it is really what you want, you should first clear the tags with clearTags method."):e.tagRefinements.length>0&&r.tagFilters?new Error("[Tags] Cannot switch from the advanced tag API to the managed API. It is probably an error, if it is not, you should first clear the tags with clearTags method."):e.numericFilters&&r.numericRefinements&&c(r.numericRefinements)?new Error("[Numeric filters] Can't switch from the advanced to the managed API. It is probably an error, if this is really what you want, you have to first clear the numeric filters."):c(e.numericRefinements)&&r.numericFilters?new Error("[Numeric filters] Can't switch from the managed API to the advanced. It is probably an error, if this is really what you want, you have to first clear the numeric filters."):null},m.prototype={constructor:m,clearRefinements:function(e){var t={numericRefinements:this._clearNumericRefinements(e),facetsRefinements:f.clearRefinement(this.facetsRefinements,e,"conjunctiveFacet"),facetsExcludes:f.clearRefinement(this.facetsExcludes,e,"exclude"),disjunctiveFacetsRefinements:f.clearRefinement(this.disjunctiveFacetsRefinements,e,"disjunctiveFacet"),hierarchicalFacetsRefinements:f.clearRefinement(this.hierarchicalFacetsRefinements,e,"hierarchicalFacet")};return t.numericRefinements===this.numericRefinements&&t.facetsRefinements===this.facetsRefinements&&t.facetsExcludes===this.facetsExcludes&&t.disjunctiveFacetsRefinements===this.disjunctiveFacetsRefinements&&t.hierarchicalFacetsRefinements===this.hierarchicalFacetsRefinements?this:this.setQueryParameters(t)},clearTags:function(){return void 0===this.tagFilters&&0===this.tagRefinements.length?this:this.setQueryParameters({tagFilters:void 0,tagRefinements:[]})},setIndex:function(e){return e===this.index?this:this.setQueryParameters({index:e})},setQuery:function(e){return e===this.query?this:this.setQueryParameters({query:e})},setPage:function(e){return e===this.page?this:this.setQueryParameters({page:e})},setFacets:function(e){return this.setQueryParameters({facets:e})},setDisjunctiveFacets:function(e){return this.setQueryParameters({disjunctiveFacets:e})},setHitsPerPage:function(e){return this.hitsPerPage===e?this:this.setQueryParameters({hitsPerPage:e})},setTypoTolerance:function(e){return this.typoTolerance===e?this:this.setQueryParameters({typoTolerance:e})},addNumericRefinement:function(e,t,r){var n=u(r);if(this.isNumericRefined(e,t,n))return this;var i=a({},this.numericRefinements);return i[e]=a({},i[e]),i[e][t]?(i[e][t]=i[e][t].slice(),i[e][t].push(n)):i[e][t]=[n],this.setQueryParameters({numericRefinements:i})},getConjunctiveRefinements:function(e){return this.isConjunctiveFacet(e)&&this.facetsRefinements[e]||[]},getDisjunctiveRefinements:function(e){return this.isDisjunctiveFacet(e)&&this.disjunctiveFacetsRefinements[e]||[]},getHierarchicalRefinement:function(e){return this.hierarchicalFacetsRefinements[e]||[]},getExcludeRefinements:function(e){return this.isConjunctiveFacet(e)&&this.facetsExcludes[e]||[]},removeNumericRefinement:function(e,t,r){var n=r;return void 0!==n?this.isNumericRefined(e,t,n)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(r,i){return i===e&&r.op===t&&l(r.val,u(n))}))}):this:void 0!==t?this.isNumericRefined(e,t)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(r,n){return n===e&&r.op===t}))}):this:this.isNumericRefined(e)?this.setQueryParameters({numericRefinements:this._clearNumericRefinements((function(t,r){return r===e}))}):this},getNumericRefinements:function(e){return this.numericRefinements[e]||{}},getNumericRefinement:function(e,t){return this.numericRefinements[e]&&this.numericRefinements[e][t]},_clearNumericRefinements:function(e){if(void 0===e)return c(this.numericRefinements)?{}:this.numericRefinements;if("string"==typeof e)return o(this.numericRefinements,[e]);if("function"==typeof e){var t=!1,r=this.numericRefinements,n=Object.keys(r).reduce((function(n,i){var s=r[i],a={};return s=s||{},Object.keys(s).forEach((function(r){var n=s[r]||[],c=[];n.forEach((function(t){e({val:t,op:r},i,"numeric")||c.push(t)})),c.length!==n.length&&(t=!0),a[r]=c})),n[i]=a,n}),{});return t?n:this.numericRefinements}},addFacet:function(e){return this.isConjunctiveFacet(e)?this:this.setQueryParameters({facets:this.facets.concat([e])})},addDisjunctiveFacet:function(e){return this.isDisjunctiveFacet(e)?this:this.setQueryParameters({disjunctiveFacets:this.disjunctiveFacets.concat([e])})},addHierarchicalFacet:function(e){if(this.isHierarchicalFacet(e.name))throw new Error("Cannot declare two hierarchical facets with the same name: `"+e.name+"`");return this.setQueryParameters({hierarchicalFacets:this.hierarchicalFacets.concat([e])})},addFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsRefinements,e,t)?this:this.setQueryParameters({facetsRefinements:f.addRefinement(this.facetsRefinements,e,t)})},addExcludeRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsExcludes,e,t)?this:this.setQueryParameters({facetsExcludes:f.addRefinement(this.facetsExcludes,e,t)})},addDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return f.isRefined(this.disjunctiveFacetsRefinements,e,t)?this:this.setQueryParameters({disjunctiveFacetsRefinements:f.addRefinement(this.disjunctiveFacetsRefinements,e,t)})},addTagRefinement:function(e){if(this.isTagRefined(e))return this;var t={tagRefinements:this.tagRefinements.concat(e)};return this.setQueryParameters(t)},removeFacet:function(e){return this.isConjunctiveFacet(e)?this.clearRefinements(e).setQueryParameters({facets:this.facets.filter((function(t){return t!==e}))}):this},removeDisjunctiveFacet:function(e){return this.isDisjunctiveFacet(e)?this.clearRefinements(e).setQueryParameters({disjunctiveFacets:this.disjunctiveFacets.filter((function(t){return t!==e}))}):this},removeHierarchicalFacet:function(e){return this.isHierarchicalFacet(e)?this.clearRefinements(e).setQueryParameters({hierarchicalFacets:this.hierarchicalFacets.filter((function(t){return t.name!==e}))}):this},removeFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsRefinements,e,t)?this.setQueryParameters({facetsRefinements:f.removeRefinement(this.facetsRefinements,e,t)}):this},removeExcludeRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return f.isRefined(this.facetsExcludes,e,t)?this.setQueryParameters({facetsExcludes:f.removeRefinement(this.facetsExcludes,e,t)}):this},removeDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return f.isRefined(this.disjunctiveFacetsRefinements,e,t)?this.setQueryParameters({disjunctiveFacetsRefinements:f.removeRefinement(this.disjunctiveFacetsRefinements,e,t)}):this},removeTagRefinement:function(e){if(!this.isTagRefined(e))return this;var t={tagRefinements:this.tagRefinements.filter((function(t){return t!==e}))};return this.setQueryParameters(t)},toggleRefinement:function(e,t){return this.toggleFacetRefinement(e,t)},toggleFacetRefinement:function(e,t){if(this.isHierarchicalFacet(e))return this.toggleHierarchicalFacetRefinement(e,t);if(this.isConjunctiveFacet(e))return this.toggleConjunctiveFacetRefinement(e,t);if(this.isDisjunctiveFacet(e))return this.toggleDisjunctiveFacetRefinement(e,t);throw new Error("Cannot refine the undeclared facet "+e+"; it should be added to the helper options facets, disjunctiveFacets or hierarchicalFacets")},toggleConjunctiveFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return this.setQueryParameters({facetsRefinements:f.toggleRefinement(this.facetsRefinements,e,t)})},toggleExcludeFacetRefinement:function(e,t){if(!this.isConjunctiveFacet(e))throw new Error(e+" is not defined in the facets attribute of the helper configuration");return this.setQueryParameters({facetsExcludes:f.toggleRefinement(this.facetsExcludes,e,t)})},toggleDisjunctiveFacetRefinement:function(e,t){if(!this.isDisjunctiveFacet(e))throw new Error(e+" is not defined in the disjunctiveFacets attribute of the helper configuration");return this.setQueryParameters({disjunctiveFacetsRefinements:f.toggleRefinement(this.disjunctiveFacetsRefinements,e,t)})},toggleHierarchicalFacetRefinement:function(e,t){if(!this.isHierarchicalFacet(e))throw new Error(e+" is not defined in the hierarchicalFacets attribute of the helper configuration");var r=this._getHierarchicalFacetSeparator(this.getHierarchicalFacetByName(e)),i={};return void 0!==this.hierarchicalFacetsRefinements[e]&&this.hierarchicalFacetsRefinements[e].length>0&&(this.hierarchicalFacetsRefinements[e][0]===t||0===this.hierarchicalFacetsRefinements[e][0].indexOf(t+r))?-1===t.indexOf(r)?i[e]=[]:i[e]=[t.slice(0,t.lastIndexOf(r))]:i[e]=[t],this.setQueryParameters({hierarchicalFacetsRefinements:n({},i,this.hierarchicalFacetsRefinements)})},addHierarchicalFacetRefinement:function(e,t){if(this.isHierarchicalFacetRefined(e))throw new Error(e+" is already refined.");if(!this.isHierarchicalFacet(e))throw new Error(e+" is not defined in the hierarchicalFacets attribute of the helper configuration.");var r={};return r[e]=[t],this.setQueryParameters({hierarchicalFacetsRefinements:n({},r,this.hierarchicalFacetsRefinements)})},removeHierarchicalFacetRefinement:function(e){if(!this.isHierarchicalFacetRefined(e))return this;var t={};return t[e]=[],this.setQueryParameters({hierarchicalFacetsRefinements:n({},t,this.hierarchicalFacetsRefinements)})},toggleTagRefinement:function(e){return this.isTagRefined(e)?this.removeTagRefinement(e):this.addTagRefinement(e)},isDisjunctiveFacet:function(e){return this.disjunctiveFacets.indexOf(e)>-1},isHierarchicalFacet:function(e){return void 0!==this.getHierarchicalFacetByName(e)},isConjunctiveFacet:function(e){return this.facets.indexOf(e)>-1},isFacetRefined:function(e,t){return!!this.isConjunctiveFacet(e)&&f.isRefined(this.facetsRefinements,e,t)},isExcludeRefined:function(e,t){return!!this.isConjunctiveFacet(e)&&f.isRefined(this.facetsExcludes,e,t)},isDisjunctiveFacetRefined:function(e,t){return!!this.isDisjunctiveFacet(e)&&f.isRefined(this.disjunctiveFacetsRefinements,e,t)},isHierarchicalFacetRefined:function(e,t){if(!this.isHierarchicalFacet(e))return!1;var r=this.getHierarchicalRefinement(e);return t?-1!==r.indexOf(t):r.length>0},isNumericRefined:function(e,t,r){if(void 0===r&&void 0===t)return Boolean(this.numericRefinements[e]);var n=this.numericRefinements[e]&&void 0!==this.numericRefinements[e][t];if(void 0===r||!n)return n;var s,a,c=u(r),o=void 0!==(s=this.numericRefinements[e][t],a=c,i(s,(function(e){return l(e,a)})));return n&&o},isTagRefined:function(e){return-1!==this.tagRefinements.indexOf(e)},getRefinedDisjunctiveFacets:function(){var e=this,t=s(Object.keys(this.numericRefinements).filter((function(t){return Object.keys(e.numericRefinements[t]).length>0})),this.disjunctiveFacets);return Object.keys(this.disjunctiveFacetsRefinements).filter((function(t){return e.disjunctiveFacetsRefinements[t].length>0})).concat(t).concat(this.getRefinedHierarchicalFacets()).sort()},getRefinedHierarchicalFacets:function(){var e=this;return s(this.hierarchicalFacets.map((function(e){return e.name})),Object.keys(this.hierarchicalFacetsRefinements).filter((function(t){return e.hierarchicalFacetsRefinements[t].length>0}))).sort()},getUnrefinedDisjunctiveFacets:function(){var e=this.getRefinedDisjunctiveFacets();return this.disjunctiveFacets.filter((function(t){return-1===e.indexOf(t)}))},managedParameters:["index","facets","disjunctiveFacets","facetsRefinements","hierarchicalFacets","facetsExcludes","disjunctiveFacetsRefinements","numericRefinements","tagRefinements","hierarchicalFacetsRefinements"],getQueryParams:function(){var e=this.managedParameters,t={},r=this;return Object.keys(this).forEach((function(n){var i=r[n];-1===e.indexOf(n)&&void 0!==i&&(t[n]=i)})),t},setQueryParameter:function(e,t){if(this[e]===t)return this;var r={};return r[e]=t,this.setQueryParameters(r)},setQueryParameters:function(e){if(!e)return this;var t=m.validate(this,e);if(t)throw t;var r=this,n=m._parseNumbers(e),i=Object.keys(this).reduce((function(e,t){return e[t]=r[t],e}),{}),s=Object.keys(n).reduce((function(e,t){var r=void 0!==e[t],i=void 0!==n[t];return r&&!i?o(e,[t]):(i&&(e[t]=n[t]),e)}),i);return new this.constructor(s)},resetPage:function(){return void 0===this.page?this:this.setPage(0)},_getHierarchicalFacetSortBy:function(e){return e.sortBy||["isRefined:desc","name:asc"]},_getHierarchicalFacetSeparator:function(e){return e.separator||" > "},_getHierarchicalRootPath:function(e){return e.rootPath||null},_getHierarchicalShowParentLevel:function(e){return"boolean"!=typeof e.showParentLevel||e.showParentLevel},getHierarchicalFacetByName:function(e){return i(this.hierarchicalFacets,(function(t){return t.name===e}))},getHierarchicalFacetBreadcrumb:function(e){if(!this.isHierarchicalFacet(e))return[];var t=this.getHierarchicalRefinement(e)[0];if(!t)return[];var r=this._getHierarchicalFacetSeparator(this.getHierarchicalFacetByName(e));return t.split(r).map((function(e){return e.trim()}))},toString:function(){return JSON.stringify(this,null,2)}},e.exports=m},6673:(e,t,r)=>{"use strict";e.exports=function(e){return function(t,r){var n=e.hierarchicalFacets[r],u=e.hierarchicalFacetsRefinements[n.name]&&e.hierarchicalFacetsRefinements[n.name][0]||"",h=e._getHierarchicalFacetSeparator(n),f=e._getHierarchicalRootPath(n),l=e._getHierarchicalShowParentLevel(n),m=s(e._getHierarchicalFacetSortBy(n)),d=t.every((function(e){return e.exhaustive})),p=function(e,t,r,n,s){return function(u,h,f){var l=u;if(f>0){var m=0;for(l=u;m{"use strict";var n=r(8965),i=r(9110),s=r(2909),a=r(849),c=r(3917),o=r(7577),u=r(4728),h=r(8601),f=s.escapeFacetValue,l=s.unescapeFacetValue,m=r(6673);function d(e){var t={};return e.forEach((function(e,r){t[e]=r})),t}function p(e,t,r){t&&t[r]&&(e.stats=t[r])}function g(e,t,r){var s=t[0]||{};this._rawResults=t;var o=this;Object.keys(s).forEach((function(e){o[e]=s[e]}));var h=u({persistHierarchicalRootCount:!1},r);Object.keys(h).forEach((function(e){o[e]=h[e]})),this.processingTimeMS=t.reduce((function(e,t){return void 0===t.processingTimeMS?e:e+t.processingTimeMS}),0),this.disjunctiveFacets=[],this.hierarchicalFacets=e.hierarchicalFacets.map((function(){return[]})),this.facets=[];var f=e.getRefinedDisjunctiveFacets(),g=d(e.facets),v=d(e.disjunctiveFacets),y=1,R=s.facets||{};Object.keys(R).forEach((function(t){var r,n,i=R[t],u=(r=e.hierarchicalFacets,n=t,a(r,(function(e){return(e.attributes||[]).indexOf(n)>-1})));if(u){var h=u.attributes.indexOf(t),f=c(e.hierarchicalFacets,(function(e){return e.name===u.name}));o.hierarchicalFacets[f][h]={attribute:t,data:i,exhaustive:s.exhaustiveFacetsCount}}else{var l,m=-1!==e.disjunctiveFacets.indexOf(t),d=-1!==e.facets.indexOf(t);m&&(l=v[t],o.disjunctiveFacets[l]={name:t,data:i,exhaustive:s.exhaustiveFacetsCount},p(o.disjunctiveFacets[l],s.facets_stats,t)),d&&(l=g[t],o.facets[l]={name:t,data:i,exhaustive:s.exhaustiveFacetsCount},p(o.facets[l],s.facets_stats,t))}})),this.hierarchicalFacets=n(this.hierarchicalFacets),f.forEach((function(r){var n=t[y],a=n&&n.facets?n.facets:{},h=e.getHierarchicalFacetByName(r);Object.keys(a).forEach((function(t){var r,f=a[t];if(h){r=c(e.hierarchicalFacets,(function(e){return e.name===h.name}));var m=c(o.hierarchicalFacets[r],(function(e){return e.attribute===t}));if(-1===m)return;o.hierarchicalFacets[r][m].data=u({},o.hierarchicalFacets[r][m].data,f)}else{r=v[t];var d=s.facets&&s.facets[t]||{};o.disjunctiveFacets[r]={name:t,data:i({},f,d),exhaustive:n.exhaustiveFacetsCount},p(o.disjunctiveFacets[r],n.facets_stats,t),e.disjunctiveFacetsRefinements[t]&&e.disjunctiveFacetsRefinements[t].forEach((function(n){!o.disjunctiveFacets[r].data[n]&&e.disjunctiveFacetsRefinements[t].indexOf(l(n))>-1&&(o.disjunctiveFacets[r].data[n]=0)}))}})),y++})),e.getRefinedHierarchicalFacets().forEach((function(r){var n=e.getHierarchicalFacetByName(r),s=e._getHierarchicalFacetSeparator(n),a=e.getHierarchicalRefinement(r);0===a.length||a[0].split(s).length<2||t.slice(y).forEach((function(t){var r=t&&t.facets?t.facets:{};Object.keys(r).forEach((function(t){var u=r[t],h=c(e.hierarchicalFacets,(function(e){return e.name===n.name})),f=c(o.hierarchicalFacets[h],(function(e){return e.attribute===t}));if(-1!==f){var l={};if(a.length>0&&!o.persistHierarchicalRootCount){var m=a[0].split(s)[0];l[m]=o.hierarchicalFacets[h][f].data[m]}o.hierarchicalFacets[h][f].data=i(l,u,o.hierarchicalFacets[h][f].data)}})),y++}))})),Object.keys(e.facetsExcludes).forEach((function(t){var r=e.facetsExcludes[t],n=g[t];o.facets[n]={name:t,data:R[t],exhaustive:s.exhaustiveFacetsCount},r.forEach((function(e){o.facets[n]=o.facets[n]||{name:t},o.facets[n].data=o.facets[n].data||{},o.facets[n].data[e]=0}))})),this.hierarchicalFacets=this.hierarchicalFacets.map(m(e)),this.facets=n(this.facets),this.disjunctiveFacets=n(this.disjunctiveFacets),this._state=e}function v(e,t){function r(e){return e.name===t}if(e._state.isConjunctiveFacet(t)){var n=a(e.facets,r);return n?Object.keys(n.data).map((function(r){var i=f(r);return{name:r,escapedValue:i,count:n.data[r],isRefined:e._state.isFacetRefined(t,i),isExcluded:e._state.isExcludeRefined(t,r)}})):[]}if(e._state.isDisjunctiveFacet(t)){var i=a(e.disjunctiveFacets,r);return i?Object.keys(i.data).map((function(r){var n=f(r);return{name:r,escapedValue:n,count:i.data[r],isRefined:e._state.isDisjunctiveFacetRefined(t,n)}})):[]}if(e._state.isHierarchicalFacet(t)){var s=a(e.hierarchicalFacets,r);if(!s)return s;var c=e._state.getHierarchicalFacetByName(t),o=e._state._getHierarchicalFacetSeparator(c),u=l(e._state.getHierarchicalRefinement(t)[0]||"");0===u.indexOf(c.rootPath)&&(u=u.replace(c.rootPath+o,""));var h=u.split(o);return h.unshift(t),y(s,h,0),s}}function y(e,t,r){e.isRefined=e.name===(t[r]&&t[r].trim()),e.data&&e.data.forEach((function(e){y(e,t,r+1)}))}function R(e,t,r,n){if(n=n||0,Array.isArray(t))return e(t,r[n]);if(!t.data||0===t.data.length)return t;var s=t.data.map((function(t){return R(e,t,r,n+1)})),a=e(s,r[n]);return i({data:a},t)}function F(e,t){var r=a(e,(function(e){return e.name===t}));return r&&r.stats}function b(e,t,r,n,i){var s=a(i,(function(e){return e.name===r})),c=s&&s.data&&s.data[n]?s.data[n]:0,o=s&&s.exhaustive||!1;return{type:t,attributeName:r,name:n,count:c,exhaustive:o}}g.prototype.getFacetByName=function(e){function t(t){return t.name===e}return a(this.facets,t)||a(this.disjunctiveFacets,t)||a(this.hierarchicalFacets,t)},g.DEFAULT_SORT=["isRefined:desc","count:desc","name:asc"],g.prototype.getFacetValues=function(e,t){var r=v(this,e);if(r){var n,s=i({},t,{sortBy:g.DEFAULT_SORT,facetOrdering:!(t&&t.sortBy)}),a=this;if(Array.isArray(r))n=[e];else n=a._state.getHierarchicalFacetByName(r.name).attributes;return R((function(e,t){if(s.facetOrdering){var r=function(e,t){return e.renderingContent&&e.renderingContent.facetOrdering&&e.renderingContent.facetOrdering.values&&e.renderingContent.facetOrdering.values[t]}(a,t);if(r)return function(e,t){var r=[],n=[],i=t.hide||[],s=(t.order||[]).reduce((function(e,t,r){return e[t]=r,e}),{});e.forEach((function(e){var t=e.path||e.name,a=i.indexOf(t)>-1;a||void 0===s[t]?a||n.push(e):r[s[t]]=e})),r=r.filter((function(e){return e}));var a,c=t.sortRemainingBy;return"hidden"===c?r:(a="alpha"===c?[["path","name"],["asc","asc"]]:[["count"],["desc"]],r.concat(h(n,a[0],a[1])))}(e,r)}if(Array.isArray(s.sortBy)){var n=o(s.sortBy,g.DEFAULT_SORT);return h(e,n[0],n[1])}if("function"==typeof s.sortBy)return function(e,t){return t.sort(e)}(s.sortBy,e);throw new Error("options.sortBy is optional but if defined it must be either an array of string (predicates) or a sorting function")}),r,n)}},g.prototype.getFacetStats=function(e){return this._state.isConjunctiveFacet(e)?F(this.facets,e):this._state.isDisjunctiveFacet(e)?F(this.disjunctiveFacets,e):void 0},g.prototype.getRefinements=function(){var e=this._state,t=this,r=[];return Object.keys(e.facetsRefinements).forEach((function(n){e.facetsRefinements[n].forEach((function(i){r.push(b(e,"facet",n,i,t.facets))}))})),Object.keys(e.facetsExcludes).forEach((function(n){e.facetsExcludes[n].forEach((function(i){r.push(b(e,"exclude",n,i,t.facets))}))})),Object.keys(e.disjunctiveFacetsRefinements).forEach((function(n){e.disjunctiveFacetsRefinements[n].forEach((function(i){r.push(b(e,"disjunctive",n,i,t.disjunctiveFacets))}))})),Object.keys(e.hierarchicalFacetsRefinements).forEach((function(n){e.hierarchicalFacetsRefinements[n].forEach((function(i){r.push(function(e,t,r,n){var i=e.getHierarchicalFacetByName(t),s=e._getHierarchicalFacetSeparator(i),c=r.split(s),o=a(n,(function(e){return e.name===t})),u=c.reduce((function(e,t){var r=e&&a(e.data,(function(e){return e.name===t}));return void 0!==r?r:e}),o),h=u&&u.count||0,f=u&&u.exhaustive||!1,l=u&&u.path||"";return{type:"hierarchical",attributeName:t,name:l,count:h,exhaustive:f}}(e,n,i,t.hierarchicalFacets))}))})),Object.keys(e.numericRefinements).forEach((function(t){var n=e.numericRefinements[t];Object.keys(n).forEach((function(e){n[e].forEach((function(n){r.push({type:"numeric",attributeName:t,name:n,numericValue:n,operator:e})}))}))})),e.tagRefinements.forEach((function(e){r.push({type:"tag",attributeName:"_tags",name:e})})),r},e.exports=g},6571:(e,t,r)=>{"use strict";var n=r(2733),i=r(6732),s=r(2909).escapeFacetValue,a=r(3014),c=r(4728),o=r(317),u=r(1383),h=r(9127),f=r(2223),l=r(9228),m=r(3371),d=r(7691),p=r(7749),g=r(6938);function v(e,t,r,n){"function"==typeof e.addAlgoliaAgent&&e.addAlgoliaAgent("JS Helper ("+g+")"),this.setClient(e);var i=r||{};i.index=t,this.state=m.make(i),this.recommendState=new h({params:i.recommendState}),this.lastResults=null,this.lastRecommendResults=null,this._queryId=0,this._recommendQueryId=0,this._lastQueryIdReceived=-1,this._lastRecommendQueryIdReceived=-1,this.derivedHelpers=[],this._currentNbQueries=0,this._currentNbRecommendQueries=0,this._searchResultsOptions=n,this._recommendCache={}}function y(e){if(e<0)throw new Error("Page requested below 0.");return this._change({state:this.state.setPage(e),isPageReset:!1}),this}function R(){return this.state.page}a(v,n),v.prototype.search=function(){return this._search({onlyWithDerivedHelpers:!1}),this},v.prototype.searchOnlyWithDerivedHelpers=function(){return this._search({onlyWithDerivedHelpers:!0}),this},v.prototype.recommend=function(){return this._recommend(),this},v.prototype.getQuery=function(){var e=this.state;return l._getHitsSearchParams(e)},v.prototype.searchOnce=function(e,t){var r=e?this.state.setQueryParameters(e):this.state,n=l._getQueries(r.index,r),i=this;if(this._currentNbQueries++,this.emit("searchOnce",{state:r}),!t)return this.client.search(n).then((function(e){return i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),{content:new d(r,e.results),state:r,_originalResponse:e}}),(function(e){throw i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),e}));this.client.search(n).then((function(e){i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),t(null,new d(r,e.results),r)})).catch((function(e){i._currentNbQueries--,0===i._currentNbQueries&&i.emit("searchQueueEmpty"),t(e,null,r)}))},v.prototype.findAnswers=function(e){console.warn("[algoliasearch-helper] answers is no longer supported");var t=this.state,r=this.derivedHelpers[0];if(!r)return Promise.resolve([]);var n=r.getModifiedState(t),i=c({attributesForPrediction:e.attributesForPrediction,nbHits:e.nbHits},{params:u(l._getHitsSearchParams(n),["attributesToSnippet","hitsPerPage","restrictSearchableAttributes","snippetEllipsisText"])}),s="search for answers was called, but this client does not have a function client.initIndex(index).findAnswers";if("function"!=typeof this.client.initIndex)throw new Error(s);var a=this.client.initIndex(n.index);if("function"!=typeof a.findAnswers)throw new Error(s);return a.findAnswers(n.query,e.queryLanguages,i)},v.prototype.searchForFacetValues=function(e,t,r,n){var i="function"==typeof this.client.searchForFacetValues,a="function"==typeof this.client.initIndex;if(!i&&!a&&"function"!=typeof this.client.search)throw new Error("search for facet values (searchable) was called, but this client does not have a function client.searchForFacetValues or client.initIndex(index).searchForFacetValues");var c=this.state.setQueryParameters(n||{}),o=c.isDisjunctiveFacet(e),u=l.getSearchForFacetQuery(e,t,r,c);this._currentNbQueries++;var h,f=this;return i?h=this.client.searchForFacetValues([{indexName:c.index,params:u}]):a?h=this.client.initIndex(c.index).searchForFacetValues(u):(delete u.facetName,h=this.client.search([{type:"facet",facet:e,indexName:c.index,params:u}]).then((function(e){return e.results[0]}))),this.emit("searchForFacetValues",{state:c,facet:e,query:t}),h.then((function(t){return f._currentNbQueries--,0===f._currentNbQueries&&f.emit("searchQueueEmpty"),(t=Array.isArray(t)?t[0]:t).facetHits.forEach((function(t){t.escapedValue=s(t.value),t.isRefined=o?c.isDisjunctiveFacetRefined(e,t.escapedValue):c.isFacetRefined(e,t.escapedValue)})),t}),(function(e){throw f._currentNbQueries--,0===f._currentNbQueries&&f.emit("searchQueueEmpty"),e}))},v.prototype.setQuery=function(e){return this._change({state:this.state.resetPage().setQuery(e),isPageReset:!0}),this},v.prototype.clearRefinements=function(e){return this._change({state:this.state.resetPage().clearRefinements(e),isPageReset:!0}),this},v.prototype.clearTags=function(){return this._change({state:this.state.resetPage().clearTags(),isPageReset:!0}),this},v.prototype.addDisjunctiveFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addDisjunctiveFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addDisjunctiveRefine=function(){return this.addDisjunctiveFacetRefinement.apply(this,arguments)},v.prototype.addHierarchicalFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addHierarchicalFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addNumericRefinement=function(e,t,r){return this._change({state:this.state.resetPage().addNumericRefinement(e,t,r),isPageReset:!0}),this},v.prototype.addFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().addFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.addRefine=function(){return this.addFacetRefinement.apply(this,arguments)},v.prototype.addFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().addExcludeRefinement(e,t),isPageReset:!0}),this},v.prototype.addExclude=function(){return this.addFacetExclusion.apply(this,arguments)},v.prototype.addTag=function(e){return this._change({state:this.state.resetPage().addTagRefinement(e),isPageReset:!0}),this},v.prototype.addFrequentlyBoughtTogether=function(e){return this._recommendChange({state:this.recommendState.addFrequentlyBoughtTogether(e)}),this},v.prototype.addRelatedProducts=function(e){return this._recommendChange({state:this.recommendState.addRelatedProducts(e)}),this},v.prototype.addTrendingItems=function(e){return this._recommendChange({state:this.recommendState.addTrendingItems(e)}),this},v.prototype.addTrendingFacets=function(e){return this._recommendChange({state:this.recommendState.addTrendingFacets(e)}),this},v.prototype.addLookingSimilar=function(e){return this._recommendChange({state:this.recommendState.addLookingSimilar(e)}),this},v.prototype.removeNumericRefinement=function(e,t,r){return this._change({state:this.state.resetPage().removeNumericRefinement(e,t,r),isPageReset:!0}),this},v.prototype.removeDisjunctiveFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().removeDisjunctiveFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.removeDisjunctiveRefine=function(){return this.removeDisjunctiveFacetRefinement.apply(this,arguments)},v.prototype.removeHierarchicalFacetRefinement=function(e){return this._change({state:this.state.resetPage().removeHierarchicalFacetRefinement(e),isPageReset:!0}),this},v.prototype.removeFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().removeFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.removeRefine=function(){return this.removeFacetRefinement.apply(this,arguments)},v.prototype.removeFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().removeExcludeRefinement(e,t),isPageReset:!0}),this},v.prototype.removeExclude=function(){return this.removeFacetExclusion.apply(this,arguments)},v.prototype.removeTag=function(e){return this._change({state:this.state.resetPage().removeTagRefinement(e),isPageReset:!0}),this},v.prototype.removeFrequentlyBoughtTogether=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeRelatedProducts=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeTrendingItems=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeTrendingFacets=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.removeLookingSimilar=function(e){return this._recommendChange({state:this.recommendState.removeParams(e)}),this},v.prototype.toggleFacetExclusion=function(e,t){return this._change({state:this.state.resetPage().toggleExcludeFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.toggleExclude=function(){return this.toggleFacetExclusion.apply(this,arguments)},v.prototype.toggleRefinement=function(e,t){return this.toggleFacetRefinement(e,t)},v.prototype.toggleFacetRefinement=function(e,t){return this._change({state:this.state.resetPage().toggleFacetRefinement(e,t),isPageReset:!0}),this},v.prototype.toggleRefine=function(){return this.toggleFacetRefinement.apply(this,arguments)},v.prototype.toggleTag=function(e){return this._change({state:this.state.resetPage().toggleTagRefinement(e),isPageReset:!0}),this},v.prototype.nextPage=function(){var e=this.state.page||0;return this.setPage(e+1)},v.prototype.previousPage=function(){var e=this.state.page||0;return this.setPage(e-1)},v.prototype.setCurrentPage=y,v.prototype.setPage=y,v.prototype.setIndex=function(e){return this._change({state:this.state.resetPage().setIndex(e),isPageReset:!0}),this},v.prototype.setQueryParameter=function(e,t){return this._change({state:this.state.resetPage().setQueryParameter(e,t),isPageReset:!0}),this},v.prototype.setState=function(e){return this._change({state:m.make(e),isPageReset:!1}),this},v.prototype.overrideStateWithoutTriggeringChangeEvent=function(e){return this.state=new m(e),this},v.prototype.hasRefinements=function(e){return!!o(this.state.getNumericRefinements(e))||(this.state.isConjunctiveFacet(e)?this.state.isFacetRefined(e):this.state.isDisjunctiveFacet(e)?this.state.isDisjunctiveFacetRefined(e):!!this.state.isHierarchicalFacet(e)&&this.state.isHierarchicalFacetRefined(e))},v.prototype.isExcluded=function(e,t){return this.state.isExcludeRefined(e,t)},v.prototype.isDisjunctiveRefined=function(e,t){return this.state.isDisjunctiveFacetRefined(e,t)},v.prototype.hasTag=function(e){return this.state.isTagRefined(e)},v.prototype.isTagRefined=function(){return this.hasTagRefinements.apply(this,arguments)},v.prototype.getIndex=function(){return this.state.index},v.prototype.getCurrentPage=R,v.prototype.getPage=R,v.prototype.getTags=function(){return this.state.tagRefinements},v.prototype.getRefinements=function(e){var t=[];if(this.state.isConjunctiveFacet(e))this.state.getConjunctiveRefinements(e).forEach((function(e){t.push({value:e,type:"conjunctive"})})),this.state.getExcludeRefinements(e).forEach((function(e){t.push({value:e,type:"exclude"})}));else if(this.state.isDisjunctiveFacet(e)){this.state.getDisjunctiveRefinements(e).forEach((function(e){t.push({value:e,type:"disjunctive"})}))}var r=this.state.getNumericRefinements(e);return Object.keys(r).forEach((function(e){var n=r[e];t.push({value:n,operator:e,type:"numeric"})})),t},v.prototype.getNumericRefinement=function(e,t){return this.state.getNumericRefinement(e,t)},v.prototype.getHierarchicalFacetBreadcrumb=function(e){return this.state.getHierarchicalFacetBreadcrumb(e)},v.prototype._search=function(e){var t=this.state,r=[],n=[];e.onlyWithDerivedHelpers||(n=l._getQueries(t.index,t),r.push({state:t,queriesCount:n.length,helper:this}),this.emit("search",{state:t,results:this.lastResults}));var i=this.derivedHelpers.map((function(e){var n=e.getModifiedState(t),i=n.index?l._getQueries(n.index,n):[];return r.push({state:n,queriesCount:i.length,helper:e}),e.emit("search",{state:n,results:e.lastResults}),i})),s=Array.prototype.concat.apply(n,i),a=this._queryId++;if(this._currentNbQueries++,!s.length)return Promise.resolve({results:[]}).then(this._dispatchAlgoliaResponse.bind(this,r,a));try{this.client.search(s).then(this._dispatchAlgoliaResponse.bind(this,r,a)).catch(this._dispatchAlgoliaError.bind(this,a))}catch(c){this.emit("error",{error:c})}},v.prototype._recommend=function(){var e=this.state,t=this.recommendState,r=this.getIndex(),n=[{state:t,index:r,helper:this}],i=t.params.map((function(e){return e.$$id}));this.emit("fetch",{recommend:{state:t,results:this.lastRecommendResults}});var s=this._recommendCache,a=this.derivedHelpers.map((function(t){var r=t.getModifiedState(e).index;if(!r)return[];var a=t.getModifiedRecommendState(new h);return n.push({state:a,index:r,helper:t}),i=Array.prototype.concat.apply(i,a.params.map((function(e){return e.$$id}))),t.emit("fetch",{recommend:{state:a,results:t.lastRecommendResults}}),a._buildQueries(r,s)})),c=Array.prototype.concat.apply(this.recommendState._buildQueries(r,s),a);if(0!==c.length)if(c.length>0&&void 0===this.client.getRecommendations)console.warn("Please update algoliasearch/lite to the latest version in order to use recommend widgets.");else{var o=this._recommendQueryId++;this._currentNbRecommendQueries++;try{this.client.getRecommendations(c).then(this._dispatchRecommendResponse.bind(this,o,n,i)).catch(this._dispatchRecommendError.bind(this,o))}catch(u){this.emit("error",{error:u})}}},v.prototype._dispatchAlgoliaResponse=function(e,t,r){var n=this;if(!(t0},v.prototype._change=function(e){var t=e.state,r=e.isPageReset;t!==this.state&&(this.state=t,this.emit("change",{state:this.state,results:this.lastResults,isPageReset:r}))},v.prototype._recommendChange=function(e){var t=e.state;t!==this.recommendState&&(this.recommendState=t,this.emit("recommend:change",{search:{results:this.lastResults,state:this.state},recommend:{results:this.lastRecommendResults,state:this.recommendState}}))},v.prototype.clearCache=function(){return this.client.clearCache&&this.client.clearCache(),this},v.prototype.setClient=function(e){return this.client===e||("function"==typeof e.addAlgoliaAgent&&e.addAlgoliaAgent("JS Helper ("+g+")"),this.client=e),this},v.prototype.getClient=function(){return this.client},v.prototype.derive=function(e,t){var r=new i(this,e,t);return this.derivedHelpers.push(r),r},v.prototype.detachDerivedHelper=function(e){var t=this.derivedHelpers.indexOf(e);if(-1===t)throw new Error("Derived helper already detached");this.derivedHelpers.splice(t,1)},v.prototype.hasPendingRequests=function(){return this._currentNbQueries>0},e.exports=v},8965:e=>{"use strict";e.exports=function(e){return Array.isArray(e)?e.filter(Boolean):[]}},9110:e=>{"use strict";e.exports=function(){return Array.prototype.slice.call(arguments).reduceRight((function(e,t){return Object.keys(Object(t)).forEach((function(r){void 0!==t[r]&&(void 0!==e[r]&&delete e[r],e[r]=t[r])})),e}),{})}},2909:e=>{"use strict";e.exports={escapeFacetValue:function(e){return"string"!=typeof e?e:String(e).replace(/^-/,"\\-")},unescapeFacetValue:function(e){return"string"!=typeof e?e:e.replace(/^\\-/,"-")}}},849:e=>{"use strict";e.exports=function(e,t){if(Array.isArray(e))for(var r=0;r{"use strict";e.exports=function(e,t){if(!Array.isArray(e))return-1;for(var r=0;r{e.exports=function(e){return e.reduce((function(e,t){return e.concat(t)}),[])}},7577:(e,t,r)=>{"use strict";var n=r(849);e.exports=function(e,t){var r=(t||[]).map((function(e){return e.split(":")}));return e.reduce((function(e,t){var i=t.split(":"),s=n(r,(function(e){return e[0]===i[0]}));return i.length>1||!s?(e[0].push(i[0]),e[1].push(i[1]),e):(e[0].push(s[0]),e[1].push(s[1]),e)}),[[],[]])}},3014:e=>{"use strict";e.exports=function(e,t){e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}})}},4843:e=>{"use strict";e.exports=function(e,t){return e.filter((function(r,n){return t.indexOf(r)>-1&&e.indexOf(r)===n}))}},4728:e=>{"use strict";function t(e){return"function"==typeof e||Array.isArray(e)||"[object Object]"===Object.prototype.toString.call(e)}function r(e,n){if(e===n)return e;for(var i in n)if(Object.prototype.hasOwnProperty.call(n,i)&&"__proto__"!==i&&"constructor"!==i){var s=n[i],a=e[i];void 0!==a&&void 0===s||(t(a)&&t(s)?e[i]=r(a,s):e[i]="object"==typeof(c=s)&&null!==c?r(Array.isArray(c)?[]:{},c):c)}var c;return e}e.exports=function(e){t(e)||(e={});for(var n=1,i=arguments.length;n{"use strict";e.exports=function(e){return e&&Object.keys(e).length>0}},1383:e=>{"use strict";e.exports=function(e,t){if(null===e)return{};var r,n,i={},s=Object.keys(e);for(n=0;n=0||(i[r]=e[r]);return i}},8601:e=>{"use strict";function t(e,t){if(e!==t){var r=void 0!==e,n=null===e,i=void 0!==t,s=null===t;if(!s&&e>t||n&&i||!r)return 1;if(!n&&e=n.length?s:"desc"===n[i]?-s:s}return e.index-r.index})),i.map((function(e){return e.value}))}},7507:e=>{"use strict";e.exports=function e(t){if("number"==typeof t)return t;if("string"==typeof t)return parseFloat(t);if(Array.isArray(t))return t.map(e);throw new Error("The value should be a number, a parsable string or an array of those.")}},9228:(e,t,r)=>{"use strict";var n=r(4728);function i(e){return Object.keys(e).sort().reduce((function(t,r){return t[r]=e[r],t}),{})}var s={_getQueries:function(e,t){var r=[];return r.push({indexName:e,params:s._getHitsSearchParams(t)}),t.getRefinedDisjunctiveFacets().forEach((function(n){r.push({indexName:e,params:s._getDisjunctiveFacetSearchParams(t,n)})})),t.getRefinedHierarchicalFacets().forEach((function(n){var i=t.getHierarchicalFacetByName(n),a=t.getHierarchicalRefinement(n),c=t._getHierarchicalFacetSeparator(i);if(a.length>0&&a[0].split(c).length>1){var o=a[0].split(c).slice(0,-1).reduce((function(e,t,r){return e.concat({attribute:i.attributes[r],value:0===r?t:[e[e.length-1].value,t].join(c)})}),[]);o.forEach((function(n,a){var c=s._getDisjunctiveFacetSearchParams(t,n.attribute,0===a);function u(e){return i.attributes.some((function(t){return t===e.split(":")[0]}))}var h=(c.facetFilters||[]).reduce((function(e,t){if(Array.isArray(t)){var r=t.filter((function(e){return!u(e)}));r.length>0&&e.push(r)}return"string"!=typeof t||u(t)||e.push(t),e}),[]),f=o[a-1];c.facetFilters=a>0?h.concat(f.attribute+":"+f.value):h.length>0?h:void 0,r.push({indexName:e,params:c})}))}})),r},_getHitsSearchParams:function(e){var t=e.facets.concat(e.disjunctiveFacets).concat(s._getHitsHierarchicalFacetsAttributes(e)).sort(),r=s._getFacetFilters(e),a=s._getNumericFilters(e),c=s._getTagFilters(e),o={};return t.length>0&&(o.facets=t.indexOf("*")>-1?["*"]:t),c.length>0&&(o.tagFilters=c),r.length>0&&(o.facetFilters=r),a.length>0&&(o.numericFilters=a),i(n({},e.getQueryParams(),o))},_getDisjunctiveFacetSearchParams:function(e,t,r){var a=s._getFacetFilters(e,t,r),c=s._getNumericFilters(e,t),o=s._getTagFilters(e),u={hitsPerPage:0,page:0,analytics:!1,clickAnalytics:!1};o.length>0&&(u.tagFilters=o);var h=e.getHierarchicalFacetByName(t);return u.facets=h?s._getDisjunctiveHierarchicalFacetAttribute(e,h,r):t,c.length>0&&(u.numericFilters=c),a.length>0&&(u.facetFilters=a),i(n({},e.getQueryParams(),u))},_getNumericFilters:function(e,t){if(e.numericFilters)return e.numericFilters;var r=[];return Object.keys(e.numericRefinements).forEach((function(n){var i=e.numericRefinements[n]||{};Object.keys(i).forEach((function(e){var s=i[e]||[];t!==n&&s.forEach((function(t){if(Array.isArray(t)){var i=t.map((function(t){return n+e+t}));r.push(i)}else r.push(n+e+t)}))}))})),r},_getTagFilters:function(e){return e.tagFilters?e.tagFilters:e.tagRefinements.join(",")},_getFacetFilters:function(e,t,r){var n=[],i=e.facetsRefinements||{};Object.keys(i).sort().forEach((function(e){(i[e]||[]).slice().sort().forEach((function(t){n.push(e+":"+t)}))}));var s=e.facetsExcludes||{};Object.keys(s).sort().forEach((function(e){(s[e]||[]).sort().forEach((function(t){n.push(e+":-"+t)}))}));var a=e.disjunctiveFacetsRefinements||{};Object.keys(a).sort().forEach((function(e){var r=a[e]||[];if(e!==t&&r&&0!==r.length){var i=[];r.slice().sort().forEach((function(t){i.push(e+":"+t)})),n.push(i)}}));var c=e.hierarchicalFacetsRefinements||{};return Object.keys(c).sort().forEach((function(i){var s=(c[i]||[])[0];if(void 0!==s){var a,o,u=e.getHierarchicalFacetByName(i),h=e._getHierarchicalFacetSeparator(u),f=e._getHierarchicalRootPath(u);if(t===i){if(-1===s.indexOf(h)||!f&&!0===r||f&&f.split(h).length===s.split(h).length)return;f?(o=f.split(h).length-1,s=f):(o=s.split(h).length-2,s=s.slice(0,s.lastIndexOf(h))),a=u.attributes[o]}else o=s.split(h).length-1,a=u.attributes[o];a&&n.push([a+":"+s])}})),n},_getHitsHierarchicalFacetsAttributes:function(e){return e.hierarchicalFacets.reduce((function(t,r){var n=e.getHierarchicalRefinement(r.name)[0];if(!n)return t.push(r.attributes[0]),t;var i=e._getHierarchicalFacetSeparator(r),s=n.split(i).length,a=r.attributes.slice(0,s+1);return t.concat(a)}),[])},_getDisjunctiveHierarchicalFacetAttribute:function(e,t,r){var n=e._getHierarchicalFacetSeparator(t);if(!0===r){var i=e._getHierarchicalRootPath(t),s=0;return i&&(s=i.split(n).length),[t.attributes[s]]}var a=(e.getHierarchicalRefinement(t.name)[0]||"").split(n).length-1;return t.attributes.slice(0,a+1)},getSearchForFacetQuery:function(e,t,r,a){var c=a.isDisjunctiveFacet(e)?a.clearRefinements(e):a,o={facetQuery:t,facetName:e};return"number"==typeof r&&(o.maxFacetHits=r),i(n({},s._getHitsSearchParams(c),o))}};e.exports=s},2208:e=>{"use strict";e.exports=function(e){return null!==e&&/^[a-zA-Z0-9_-]{1,64}$/.test(e)}},7749:(e,t,r)=>{"use strict";var n=r(849),i=r(8657);e.exports=function(e){var t={};return e.forEach((function(e){e.forEach((function(e,r){t[e.objectID]?t[e.objectID]={indexSum:t[e.objectID].indexSum+r,count:t[e.objectID].count+1}:t[e.objectID]={indexSum:r,count:1}}))})),function(e,t){var r=[];return Object.keys(e).forEach((function(n){e[n].count<2&&(e[n].indexSum+=100),r.push({objectID:n,avgOfIndices:e[n].indexSum/t})})),r.sort((function(e,t){return e.avgOfIndices>t.avgOfIndices?1:-1}))}(t,e.length).reduce((function(t,r){var s=n(i(e),(function(e){return e.objectID===r.objectID}));return s?t.concat(s):t}),[])}},6938:e=>{"use strict";e.exports="3.22.2"},3643:function(e){e.exports=function(){"use strict";function e(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function t(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function r(r){for(var n=1;n=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}function i(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){if(Symbol.iterator in Object(e)||"[object Arguments]"===Object.prototype.toString.call(e)){var r=[],n=!0,i=!1,s=void 0;try{for(var a,c=e[Symbol.iterator]();!(n=(a=c.next()).done)&&(r.push(a.value),!t||r.length!==t);n=!0);}catch(e){i=!0,s=e}finally{try{n||null==c.return||c.return()}finally{if(i)throw s}}return r}}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance")}()}function s(e){return function(e){if(Array.isArray(e)){for(var t=0,r=new Array(e.length);t2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return Promise.resolve().then((function(){c();var t=JSON.stringify(e);return s()[t]})).then((function(e){return Promise.all([e?e.value:t(),void 0!==e])})).then((function(e){var t=i(e,2),n=t[0],s=t[1];return Promise.all([n,s||r.miss(n)])})).then((function(e){return i(e,1)[0]}))},set:function(e,t){return Promise.resolve().then((function(){var i=s();return i[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},n().setItem(r,JSON.stringify(i)),t}))},delete:function(e){return Promise.resolve().then((function(){var t=s();delete t[JSON.stringify(e)],n().setItem(r,JSON.stringify(t))}))},clear:function(){return Promise.resolve().then((function(){n().removeItem(r)}))}}}function c(e){var t=s(e.caches),r=t.shift();return void 0===r?{get:function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return t().then((function(e){return Promise.all([e,r.miss(e)])})).then((function(e){return i(e,1)[0]}))},set:function(e,t){return Promise.resolve(t)},delete:function(e){return Promise.resolve()},clear:function(){return Promise.resolve()}}:{get:function(e,n){var i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}};return r.get(e,n,i).catch((function(){return c({caches:t}).get(e,n,i)}))},set:function(e,n){return r.set(e,n).catch((function(){return c({caches:t}).set(e,n)}))},delete:function(e){return r.delete(e).catch((function(){return c({caches:t}).delete(e)}))},clear:function(){return r.clear().catch((function(){return c({caches:t}).clear()}))}}}function o(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{serializable:!0},t={};return{get:function(r,n){var i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{miss:function(){return Promise.resolve()}},s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);var a=n(),c=i&&i.miss||function(){return Promise.resolve()};return a.then((function(e){return c(e)})).then((function(){return a}))},set:function(r,n){return t[JSON.stringify(r)]=e.serializable?JSON.stringify(n):n,Promise.resolve(n)},delete:function(e){return delete t[JSON.stringify(e)],Promise.resolve()},clear:function(){return t={},Promise.resolve()}}}function u(e){for(var t=e.length-1;t>0;t--){var r=Math.floor(Math.random()*(t+1)),n=e[t];e[t]=e[r],e[r]=n}return e}function h(e,t){return t?(Object.keys(t).forEach((function(r){e[r]=t[r](e)})),e):e}function f(e){for(var t=arguments.length,r=new Array(t>1?t-1:0),n=1;n0?n:void 0,timeout:r.timeout||t,headers:r.headers||{},queryParameters:r.queryParameters||{},cacheable:r.cacheable}}var d={Read:1,Write:2,Any:3},p=1,g=2,v=3;function y(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:p;return r(r({},e),{},{status:t,lastUpdate:Date.now()})}function R(e){return"string"==typeof e?{protocol:"https",url:e,accept:d.Any}:{protocol:e.protocol||"https",url:e.url,accept:e.accept||d.Any}}var F="GET",b="POST";function j(e,t){return Promise.all(t.map((function(t){return e.get(t,(function(){return Promise.resolve(y(t))}))}))).then((function(e){var r=e.filter((function(e){return function(e){return e.status===p||Date.now()-e.lastUpdate>12e4}(e)})),n=e.filter((function(e){return function(e){return e.status===v&&Date.now()-e.lastUpdate<=12e4}(e)})),i=[].concat(s(r),s(n));return{getTimeout:function(e,t){return(0===n.length&&0===e?1:n.length+3+e)*t},statelessHosts:i.length>0?i.map((function(e){return R(e)})):t}}))}function P(e,t,n,i){var a=[],c=function(e,t){if(e.method!==F&&(void 0!==e.data||void 0!==t.data)){var n=Array.isArray(e.data)?e.data:r(r({},e.data),t.data);return JSON.stringify(n)}}(n,i),o=function(e,t){var n=r(r({},e.headers),t.headers),i={};return Object.keys(n).forEach((function(e){var t=n[e];i[e.toLowerCase()]=t})),i}(e,i),u=n.method,h=n.method!==F?{}:r(r({},n.data),i.data),f=r(r(r({"x-algolia-agent":e.userAgent.value},e.queryParameters),h),i.queryParameters),l=0,m=function t(r,s){var h=r.pop();if(void 0===h)throw{name:"RetryError",message:"Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support .",transporterStackTrace:O(a)};var m={data:c,headers:o,method:u,url:x(h,n.path,f),connectTimeout:s(l,e.timeouts.connect),responseTimeout:s(l,i.timeout)},d=function(e){var t={request:m,response:e,host:h,triesLeft:r.length};return a.push(t),t},p={onSuccess:function(e){return function(e){try{return JSON.parse(e.content)}catch(t){throw function(e,t){return{name:"DeserializationError",message:e,response:t}}(t.message,e)}}(e)},onRetry:function(n){var i=d(n);return n.isTimedOut&&l++,Promise.all([e.logger.info("Retryable failure",w(i)),e.hostsCache.set(h,y(h,n.isTimedOut?v:g))]).then((function(){return t(r,s)}))},onFail:function(e){throw d(e),function(e,t){var r=e.content,n=e.status,i=r;try{i=JSON.parse(r).message}catch(e){}return function(e,t,r){return{name:"ApiError",message:e,status:t,transporterStackTrace:r}}(i,n,t)}(e,O(a))}};return e.requester.send(m).then((function(e){return function(e,t){return function(e){var t=e.status;return e.isTimedOut||function(e){var t=e.isTimedOut,r=e.status;return!t&&!~~r}(e)||2!=~~(t/100)&&4!=~~(t/100)}(e)?t.onRetry(e):2==~~(e.status/100)?t.onSuccess(e):t.onFail(e)}(e,p)}))};return j(e.hostsCache,t).then((function(e){return m(s(e.statelessHosts).reverse(),e.getTimeout)}))}function _(e){var t={value:"Algolia for JavaScript (".concat(e,")"),add:function(e){var r="; ".concat(e.segment).concat(void 0!==e.version?" (".concat(e.version,")"):"");return-1===t.value.indexOf(r)&&(t.value="".concat(t.value).concat(r)),t}};return t}function x(e,t,r){var n=E(r),i="".concat(e.protocol,"://").concat(e.url,"/").concat("/"===t.charAt(0)?t.substr(1):t);return n.length&&(i+="?".concat(n)),i}function E(e){return Object.keys(e).map((function(t){return f("%s=%s",t,(r=e[t],"[object Object]"===Object.prototype.toString.call(r)||"[object Array]"===Object.prototype.toString.call(r)?JSON.stringify(e[t]):e[t]));var r})).join("&")}function O(e){return e.map((function(e){return w(e)}))}function w(e){var t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return r(r({},e),{},{request:r(r({},e.request),{},{headers:r(r({},e.request.headers),t)})})}var S=function(e){var t=e.appId,n=function(e,t,r){var n={"x-algolia-api-key":r,"x-algolia-application-id":t};return{headers:function(){return e===l.WithinHeaders?n:{}},queryParameters:function(){return e===l.WithinQueryParameters?n:{}}}}(void 0!==e.authMode?e.authMode:l.WithinHeaders,t,e.apiKey),s=function(e){var t=e.hostsCache,r=e.logger,n=e.requester,s=e.requestsCache,a=e.responsesCache,c=e.timeouts,o=e.userAgent,u=e.hosts,h=e.queryParameters,f={hostsCache:t,logger:r,requester:n,requestsCache:s,responsesCache:a,timeouts:c,userAgent:o,headers:e.headers,queryParameters:h,hosts:u.map((function(e){return R(e)})),read:function(e,t){var r=m(t,f.timeouts.read),n=function(){return P(f,f.hosts.filter((function(e){return!!(e.accept&d.Read)})),e,r)};if(!0!==(void 0!==r.cacheable?r.cacheable:e.cacheable))return n();var s={request:e,mappedRequestOptions:r,transporter:{queryParameters:f.queryParameters,headers:f.headers}};return f.responsesCache.get(s,(function(){return f.requestsCache.get(s,(function(){return f.requestsCache.set(s,n()).then((function(e){return Promise.all([f.requestsCache.delete(s),e])}),(function(e){return Promise.all([f.requestsCache.delete(s),Promise.reject(e)])})).then((function(e){var t=i(e,2);return t[0],t[1]}))}))}),{miss:function(e){return f.responsesCache.set(s,e)}})},write:function(e,t){return P(f,f.hosts.filter((function(e){return!!(e.accept&d.Write)})),e,m(t,f.timeouts.write))}};return f}(r(r({hosts:[{url:"".concat(t,"-dsn.algolia.net"),accept:d.Read},{url:"".concat(t,".algolia.net"),accept:d.Write}].concat(u([{url:"".concat(t,"-1.algolianet.com")},{url:"".concat(t,"-2.algolianet.com")},{url:"".concat(t,"-3.algolianet.com")}]))},e),{},{headers:r(r(r({},n.headers()),{"content-type":"application/x-www-form-urlencoded"}),e.headers),queryParameters:r(r({},n.queryParameters()),e.queryParameters)}));return h({transporter:s,appId:t,addAlgoliaAgent:function(e,t){s.userAgent.add({segment:e,version:t})},clearCache:function(){return Promise.all([s.requestsCache.clear(),s.responsesCache.clear()]).then((function(){}))}},e.methods)},A=function(e){return function(t,r){return t.method===F?e.transporter.read(t,r):e.transporter.write(t,r)}},N=function(e){return function(t){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return h({transporter:e.transporter,appId:e.appId,indexName:t},r.methods)}},T=function(e){return function(t,n){var i=t.map((function(e){return r(r({},e),{},{params:E(e.params||{})})}));return e.transporter.read({method:b,path:"1/indexes/*/queries",data:{requests:i},cacheable:!0},n)}},H=function(e){return function(t,i){return Promise.all(t.map((function(t){var s=t.params,a=s.facetName,c=s.facetQuery,o=n(s,["facetName","facetQuery"]);return N(e)(t.indexName,{methods:{searchForFacetValues:I}}).searchForFacetValues(a,c,r(r({},i),o))})))}},Q=function(e){return function(t,r,n){return e.transporter.read({method:b,path:f("1/answers/%s/prediction",e.indexName),data:{query:t,queryLanguages:r},cacheable:!0},n)}},C=function(e){return function(t,r){return e.transporter.read({method:b,path:f("1/indexes/%s/query",e.indexName),data:{query:t},cacheable:!0},r)}},I=function(e){return function(t,r,n){return e.transporter.read({method:b,path:f("1/indexes/%s/facets/%s/query",e.indexName,t),data:{facetQuery:r},cacheable:!0},n)}},D=1,k=2,q=3,L=function(e){return function(t,n){var i=t.map((function(e){return r(r({},e),{},{threshold:e.threshold||0})}));return e.transporter.read({method:b,path:"1/indexes/*/recommendations",data:{requests:i},cacheable:!0},n)}};function V(e,t,n){var i,s={appId:e,apiKey:t,timeouts:{connect:1,read:2,write:30},requester:{send:function(e){return new Promise((function(t){var r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((function(t){return r.setRequestHeader(t,e.headers[t])}));var n,i=function(e,n){return setTimeout((function(){r.abort(),t({status:0,content:n,isTimedOut:!0})}),1e3*e)},s=i(e.connectTimeout,"Connection timeout");r.onreadystatechange=function(){r.readyState>r.OPENED&&void 0===n&&(clearTimeout(s),n=i(e.responseTimeout,"Socket timeout"))},r.onerror=function(){0===r.status&&(clearTimeout(s),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=function(){clearTimeout(s),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},logger:(i=q,{debug:function(e,t){return D>=i&&console.debug(e,t),Promise.resolve()},info:function(e,t){return k>=i&&console.info(e,t),Promise.resolve()},error:function(e,t){return console.error(e,t),Promise.resolve()}}),responsesCache:o(),requestsCache:o({serializable:!1}),hostsCache:c({caches:[a({key:"".concat("4.24.0","-").concat(e)}),o()]}),userAgent:_("4.24.0").add({segment:"Browser",version:"lite"}),authMode:l.WithinQueryParameters};return S(r(r(r({},s),n),{},{methods:{search:T,searchForFacetValues:H,multipleQueries:T,multipleSearchForFacetValues:H,customRequest:A,initIndex:function(e){return function(t){return N(e)(t,{methods:{search:C,searchForFacetValues:I,findAnswers:Q}})}},getRecommendations:L}}))}return V.version="4.24.0",V}()},5846:(e,t,r)=>{"use strict";r.d(t,{W:()=>u});var n=r(6540),i=r(4586);const s=["zero","one","two","few","many","other"];function a(e){return s.filter((t=>e.includes(t)))}const c={locale:"en",pluralForms:a(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,i.A)();return(0,n.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:a(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),c}}),[e])}function u(){const e=o();return{selectMessage:(t,r)=>function(e,t,r){const n=e.split("|");if(1===n.length)return n[0];n.length>r.pluralForms.length&&console.error(`For locale=${r.locale}, a maximum of ${r.pluralForms.length} plural forms are expected (${r.pluralForms.join(",")}), but the message contains ${n.length}: ${e}`);const i=r.select(t),s=r.pluralForms.indexOf(i);return n[Math.min(s,n.length-1)]}(r,t,e)}}},4604:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>w});var n=r(6540),i=r(4164),s=r(4103),a=r.n(s),c=r(3643),o=r.n(c),u=r(8193),h=r(5260),f=r(8774),l=r(4070),m=r(5846),d=r(4255),p=r(9532),g=r(5500),v=r(481),y=r(1312),R=r(4586),F=r(8126),b=r(1062),j=r(9201),P=r(1107);const _={searchQueryInput:"searchQueryInput_u2C7",searchVersionInput:"searchVersionInput_m0Ui",searchResultsColumn:"searchResultsColumn_JPFH",algoliaLogo:"algoliaLogo_rT1R",algoliaLogoPathFill:"algoliaLogoPathFill_WdUC",searchResultItem:"searchResultItem_Tv2o",searchResultItemHeading:"searchResultItemHeading_KbCB",searchResultItemPath:"searchResultItemPath_lhe1",searchResultItemSummary:"searchResultItemSummary_AEaO",searchQueryColumn:"searchQueryColumn_RTkw",searchVersionColumn:"searchVersionColumn_ypXd",searchLogoColumn:"searchLogoColumn_rJIA",loadingSpinner:"loadingSpinner_XVxU","loading-spin":"loading-spin_vzvp",loader:"loader_vvXV"};var x=r(4848);function E(e){let{docsSearchVersionsHelpers:t}=e;const r=Object.entries(t.allDocsData).filter((e=>{let[,t]=e;return t.versions.length>1}));return(0,x.jsx)("div",{className:(0,i.A)("col","col--3","padding-left--none",_.searchVersionColumn),children:r.map((e=>{let[n,i]=e;const s=r.length>1?`${n}: `:"";return(0,x.jsx)("select",{onChange:e=>t.setSearchVersion(n,e.target.value),defaultValue:t.searchVersions[n],className:_.searchVersionInput,children:i.versions.map(((e,t)=>(0,x.jsx)("option",{label:`${s}${e.label}`,value:e.name},t)))},n)}))})}function O(){const{i18n:{currentLocale:e}}=(0,R.A)(),{algolia:{appId:t,apiKey:r,indexName:s,contextualSearch:c}}=(0,F.c)(),g=(0,b.C)(),O=function(){const{selectMessage:e}=(0,m.W)();return t=>e(t,(0,y.T)({id:"theme.SearchPage.documentsFound.plurals",description:'Pluralized label for "{count} documents found". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One document found|{count} documents found"},{count:t}))}(),w=function(){const e=(0,l.Gy)(),[t,r]=(0,n.useState)((()=>Object.entries(e).reduce(((e,t)=>{let[r,n]=t;return{...e,[r]:n.versions[0].name}}),{}))),i=Object.values(e).some((e=>e.versions.length>1));return{allDocsData:e,versioningEnabled:i,searchVersions:t,setSearchVersion:(e,t)=>r((r=>({...r,[e]:t})))}}(),[S,A]=(0,d.b)(),N={items:[],query:null,totalResults:null,totalPages:null,lastPage:null,hasMore:null,loading:null},[T,H]=(0,n.useReducer)(((e,t)=>{switch(t.type){case"reset":return N;case"loading":return{...e,loading:!0};case"update":return S!==t.value.query?e:{...t.value,items:0===t.value.lastPage?t.value.items:e.items.concat(t.value.items)};case"advance":{const t=e.totalPages>e.lastPage+1;return{...e,lastPage:t?e.lastPage+1:e.lastPage,hasMore:t}}default:return e}}),N),Q=c?["language","docusaurus_tag"]:[],C=o()(t,r),I=a()(C,s,{hitsPerPage:15,advancedSyntax:!0,disjunctiveFacets:Q});I.on("result",(e=>{let{results:{query:t,hits:r,page:n,nbHits:i,nbPages:s}}=e;if(""===t||!Array.isArray(r))return void H({type:"reset"});const a=e=>e.replace(/algolia-docsearch-suggestion--highlight/g,"search-result-match"),c=r.map((e=>{let{url:t,_highlightResult:{hierarchy:r},_snippetResult:n={}}=e;const i=Object.keys(r).map((e=>a(r[e].value)));return{title:i.pop(),url:g(t),summary:n.content?`${a(n.content.value)}...`:"",breadcrumbs:i}}));H({type:"update",value:{items:c,query:t,totalResults:i,totalPages:s,lastPage:n,hasMore:s>n+1,loading:!1}})}));const[D,k]=(0,n.useState)(null),q=(0,n.useRef)(0),L=(0,n.useRef)(u.A.canUseIntersectionObserver&&new IntersectionObserver((e=>{const{isIntersecting:t,boundingClientRect:{y:r}}=e[0];t&&q.current>r&&H({type:"advance"}),q.current=r}),{threshold:1})),V=()=>S?(0,y.T)({id:"theme.SearchPage.existingResultsTitle",message:'Search results for "{query}"',description:"The search page title for non-empty query"},{query:S}):(0,y.T)({id:"theme.SearchPage.emptyResultsTitle",message:"Search the documentation",description:"The search page title for empty query"}),B=(0,p._q)((function(t){void 0===t&&(t=0),c&&(I.addDisjunctiveFacetRefinement("docusaurus_tag","default"),I.addDisjunctiveFacetRefinement("language",e),Object.entries(w.searchVersions).forEach((e=>{let[t,r]=e;I.addDisjunctiveFacetRefinement("docusaurus_tag",`docs-${t}-${r}`)}))),I.setQuery(S).setPage(t).search()}));return(0,n.useEffect)((()=>{if(!D)return;const e=L.current;return e?(e.observe(D),()=>e.unobserve(D)):()=>!0}),[D]),(0,n.useEffect)((()=>{H({type:"reset"}),S&&(H({type:"loading"}),setTimeout((()=>{B()}),300))}),[S,w.searchVersions,B]),(0,n.useEffect)((()=>{T.lastPage&&0!==T.lastPage&&B(T.lastPage)}),[B,T.lastPage]),(0,x.jsxs)(j.A,{children:[(0,x.jsxs)(h.A,{children:[(0,x.jsx)("title",{children:(0,v.s)(V())}),(0,x.jsx)("meta",{property:"robots",content:"noindex, follow"})]}),(0,x.jsxs)("div",{className:"container margin-vert--lg",children:[(0,x.jsx)(P.A,{as:"h1",children:V()}),(0,x.jsxs)("form",{className:"row",onSubmit:e=>e.preventDefault(),children:[(0,x.jsx)("div",{className:(0,i.A)("col",_.searchQueryColumn,{"col--9":w.versioningEnabled,"col--12":!w.versioningEnabled}),children:(0,x.jsx)("input",{type:"search",name:"q",className:_.searchQueryInput,placeholder:(0,y.T)({id:"theme.SearchPage.inputPlaceholder",message:"Type your search here",description:"The placeholder for search page input"}),"aria-label":(0,y.T)({id:"theme.SearchPage.inputLabel",message:"Search",description:"The ARIA label for search page input"}),onChange:e=>A(e.target.value),value:S,autoComplete:"off",autoFocus:!0})}),c&&w.versioningEnabled&&(0,x.jsx)(E,{docsSearchVersionsHelpers:w})]}),(0,x.jsxs)("div",{className:"row",children:[(0,x.jsx)("div",{className:(0,i.A)("col","col--8",_.searchResultsColumn),children:!!T.totalResults&&O(T.totalResults)}),(0,x.jsx)("div",{className:(0,i.A)("col","col--4","text--right",_.searchLogoColumn),children:(0,x.jsx)(f.A,{to:"https://www.algolia.com/","aria-label":(0,y.T)({id:"theme.SearchPage.algoliaLabel",message:"Search by Algolia",description:"The ARIA label for Algolia mention"}),children:(0,x.jsx)("svg",{viewBox:"0 0 168 24",className:_.algoliaLogo,children:(0,x.jsxs)("g",{fill:"none",children:[(0,x.jsx)("path",{className:_.algoliaLogoPathFill,d:"M120.925 18.804c-4.386.02-4.386-3.54-4.386-4.106l-.007-13.336 2.675-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-10.846-2.18c.821 0 1.43-.047 1.855-.129v-2.719a6.334 6.334 0 0 0-1.574-.199 5.7 5.7 0 0 0-.897.069 2.699 2.699 0 0 0-.814.24c-.24.116-.439.28-.582.491-.15.212-.219.335-.219.656 0 .628.219.991.616 1.23s.938.362 1.615.362zm-.233-9.7c.883 0 1.629.109 2.231.328.602.218 1.088.525 1.444.915.363.396.609.922.76 1.483.157.56.232 1.175.232 1.85v6.874a32.5 32.5 0 0 1-1.868.314c-.834.123-1.772.185-2.813.185-.69 0-1.327-.069-1.895-.198a4.001 4.001 0 0 1-1.471-.636 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.803 0-.656.13-1.073.384-1.525a3.24 3.24 0 0 1 1.047-1.106c.445-.287.95-.492 1.532-.615a8.8 8.8 0 0 1 1.82-.185 8.404 8.404 0 0 1 1.972.24v-.438c0-.307-.035-.6-.11-.874a1.88 1.88 0 0 0-.384-.73 1.784 1.784 0 0 0-.724-.493 3.164 3.164 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.735 7.735 0 0 0-1.26.307l-.321-2.192c.335-.117.834-.233 1.478-.349a10.98 10.98 0 0 1 2.073-.178zm52.842 9.626c.822 0 1.43-.048 1.854-.13V13.7a6.347 6.347 0 0 0-1.574-.199c-.294 0-.595.021-.896.069a2.7 2.7 0 0 0-.814.24 1.46 1.46 0 0 0-.582.491c-.15.212-.218.335-.218.656 0 .628.218.991.615 1.23.404.245.938.362 1.615.362zm-.226-9.694c.883 0 1.629.108 2.231.327.602.219 1.088.526 1.444.915.355.39.609.923.759 1.483a6.8 6.8 0 0 1 .233 1.852v6.873c-.41.088-1.034.19-1.868.314-.834.123-1.772.184-2.813.184-.69 0-1.327-.068-1.895-.198a4.001 4.001 0 0 1-1.471-.635 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.804 0-.656.13-1.073.384-1.524.26-.45.608-.82 1.047-1.107.445-.286.95-.491 1.532-.614a8.803 8.803 0 0 1 2.751-.13c.329.034.671.096 1.04.185v-.437a3.3 3.3 0 0 0-.109-.875 1.873 1.873 0 0 0-.384-.731 1.784 1.784 0 0 0-.724-.492 3.165 3.165 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.75 7.75 0 0 0-1.26.307l-.321-2.193c.335-.116.834-.232 1.478-.348a11.633 11.633 0 0 1 2.073-.177zm-8.034-1.271a1.626 1.626 0 0 1-1.628-1.62c0-.895.725-1.62 1.628-1.62.904 0 1.63.725 1.63 1.62 0 .895-.733 1.62-1.63 1.62zm1.348 13.22h-2.689V7.27l2.69-.423v11.956zm-4.714 0c-4.386.02-4.386-3.54-4.386-4.107l-.008-13.336 2.676-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-8.698-5.903c0-1.156-.253-2.119-.746-2.788-.493-.677-1.183-1.01-2.067-1.01-.882 0-1.574.333-2.065 1.01-.493.676-.733 1.632-.733 2.788 0 1.168.246 1.953.74 2.63.492.683 1.183 1.018 2.066 1.018.882 0 1.574-.342 2.067-1.019.492-.683.738-1.46.738-2.63zm2.737-.007c0 .902-.13 1.584-.397 2.33a5.52 5.52 0 0 1-1.128 1.906 4.986 4.986 0 0 1-1.752 1.223c-.685.286-1.739.45-2.265.45-.528-.006-1.574-.157-2.252-.45a5.096 5.096 0 0 1-1.744-1.223c-.487-.527-.863-1.162-1.137-1.906a6.345 6.345 0 0 1-.41-2.33c0-.902.123-1.77.397-2.508a5.554 5.554 0 0 1 1.15-1.892 5.133 5.133 0 0 1 1.75-1.216c.679-.287 1.425-.423 2.232-.423.808 0 1.553.142 2.237.423a4.88 4.88 0 0 1 1.753 1.216 5.644 5.644 0 0 1 1.135 1.892c.287.738.431 1.606.431 2.508zm-20.138 0c0 1.12.246 2.363.738 2.882.493.52 1.13.78 1.91.78.424 0 .828-.062 1.204-.178.377-.116.677-.253.917-.417V9.33a10.476 10.476 0 0 0-1.766-.226c-.971-.028-1.71.37-2.23 1.004-.513.636-.773 1.75-.773 2.788zm7.438 5.274c0 1.824-.466 3.156-1.404 4.004-.936.846-2.367 1.27-4.296 1.27-.705 0-2.17-.137-3.34-.396l.431-2.118c.98.205 2.272.26 2.95.26 1.074 0 1.84-.219 2.299-.656.459-.437.684-1.086.684-1.948v-.437a8.07 8.07 0 0 1-1.047.397c-.43.13-.93.198-1.492.198-.739 0-1.41-.116-2.018-.349a4.206 4.206 0 0 1-1.567-1.025c-.431-.45-.774-1.017-1.013-1.694-.24-.677-.363-1.885-.363-2.773 0-.834.13-1.88.384-2.577.26-.696.629-1.298 1.129-1.796.493-.498 1.095-.881 1.8-1.162a6.605 6.605 0 0 1 2.428-.457c.87 0 1.67.109 2.45.24.78.129 1.444.265 1.985.415V18.17zM6.972 6.677v1.627c-.712-.446-1.52-.67-2.425-.67-.585 0-1.045.13-1.38.391a1.24 1.24 0 0 0-.502 1.03c0 .425.164.765.494 1.02.33.256.835.532 1.516.83.447.192.795.356 1.045.495.25.138.537.332.862.582.324.25.563.548.718.894.154.345.23.741.23 1.188 0 .947-.334 1.691-1.004 2.234-.67.542-1.537.814-2.601.814-1.18 0-2.16-.229-2.936-.686v-1.708c.84.628 1.814.942 2.92.942.585 0 1.048-.136 1.388-.407.34-.271.51-.646.51-1.125 0-.287-.1-.55-.302-.79-.203-.24-.42-.42-.655-.542-.234-.123-.585-.29-1.053-.503a61.27 61.27 0 0 1-.582-.271 13.67 13.67 0 0 1-.55-.287 4.275 4.275 0 0 1-.567-.351 6.92 6.92 0 0 1-.455-.4c-.18-.17-.31-.34-.39-.51-.08-.17-.155-.37-.224-.598a2.553 2.553 0 0 1-.104-.742c0-.915.333-1.638.998-2.17.664-.532 1.523-.798 2.576-.798.968 0 1.793.17 2.473.51zm7.468 5.696v-.287c-.022-.607-.187-1.088-.495-1.444-.309-.357-.75-.535-1.324-.535-.532 0-.99.194-1.373.583-.382.388-.622.949-.717 1.683h3.909zm1.005 2.792v1.404c-.596.34-1.383.51-2.362.51-1.255 0-2.255-.377-3-1.132-.744-.755-1.116-1.744-1.116-2.968 0-1.297.34-2.316 1.021-3.055.68-.74 1.548-1.11 2.6-1.11 1.033 0 1.852.323 2.458.966.606.644.91 1.572.91 2.784 0 .33-.033.676-.096 1.038h-5.314c.107.702.405 1.239.894 1.611.49.372 1.106.558 1.85.558.862 0 1.58-.202 2.155-.606zm6.605-1.77h-1.212c-.596 0-1.045.116-1.349.35-.303.234-.454.532-.454.894 0 .372.117.664.35.877.235.213.575.32 1.022.32.51 0 .912-.142 1.204-.424.293-.281.44-.651.44-1.108v-.91zm-4.068-2.554V9.325c.627-.361 1.457-.542 2.489-.542 2.116 0 3.175 1.026 3.175 3.08V17h-1.548v-.957c-.415.68-1.143 1.02-2.186 1.02-.766 0-1.38-.22-1.843-.661-.462-.442-.694-1.003-.694-1.684 0-.776.293-1.38.878-1.81.585-.431 1.404-.647 2.457-.647h1.34V11.8c0-.554-.133-.971-.399-1.253-.266-.282-.707-.423-1.324-.423a4.07 4.07 0 0 0-2.345.718zm9.333-1.93v1.42c.394-1 1.101-1.5 2.123-1.5.148 0 .313.016.494.048v1.531a1.885 1.885 0 0 0-.75-.143c-.542 0-.989.24-1.34.718-.351.479-.527 1.048-.527 1.707V17h-1.563V8.91h1.563zm5.01 4.084c.022.82.272 1.492.75 2.019.479.526 1.15.79 2.01.79.639 0 1.235-.176 1.788-.527v1.404c-.521.319-1.186.479-1.995.479-1.265 0-2.276-.4-3.031-1.197-.755-.798-1.133-1.792-1.133-2.984 0-1.16.38-2.151 1.14-2.975.761-.825 1.79-1.237 3.088-1.237.702 0 1.346.149 1.93.447v1.436a3.242 3.242 0 0 0-1.77-.495c-.84 0-1.513.266-2.019.798-.505.532-.758 1.213-.758 2.042zM40.24 5.72v4.579c.458-1 1.293-1.5 2.505-1.5.787 0 1.42.245 1.899.734.479.49.718 1.17.718 2.042V17h-1.564v-5.106c0-.553-.14-.98-.422-1.284-.282-.303-.652-.455-1.11-.455-.531 0-1.002.202-1.411.606-.41.405-.615 1.022-.615 1.851V17h-1.563V5.72h1.563zm14.966 10.02c.596 0 1.096-.253 1.5-.758.404-.506.606-1.157.606-1.955 0-.915-.202-1.62-.606-2.114-.404-.495-.92-.742-1.548-.742-.553 0-1.05.224-1.491.67-.442.447-.662 1.133-.662 2.058 0 .958.212 1.67.638 2.138.425.469.946.703 1.563.703zM53.004 5.72v4.42c.574-.894 1.388-1.341 2.44-1.341 1.022 0 1.857.383 2.506 1.149.649.766.973 1.781.973 3.047 0 1.138-.309 2.109-.925 2.912-.617.803-1.463 1.205-2.537 1.205-1.075 0-1.894-.447-2.457-1.34V17h-1.58V5.72h1.58zm9.908 11.104l-3.223-7.913h1.739l1.005 2.632 1.26 3.415c.096-.32.48-1.458 1.15-3.415l.909-2.632h1.66l-2.92 7.866c-.777 2.074-1.963 3.11-3.559 3.11a2.92 2.92 0 0 1-.734-.079v-1.34c.17.042.351.064.543.064 1.032 0 1.755-.57 2.17-1.708z"}),(0,x.jsx)("path",{fill:"#5468FF",d:"M78.988.938h16.594a2.968 2.968 0 0 1 2.966 2.966V20.5a2.967 2.967 0 0 1-2.966 2.964H78.988a2.967 2.967 0 0 1-2.966-2.964V3.897A2.961 2.961 0 0 1 78.988.938z"}),(0,x.jsx)("path",{fill:"white",d:"M89.632 5.967v-.772a.978.978 0 0 0-.978-.977h-2.28a.978.978 0 0 0-.978.977v.793c0 .088.082.15.171.13a7.127 7.127 0 0 1 1.984-.28c.65 0 1.295.088 1.917.259.082.02.164-.04.164-.13m-6.248 1.01l-.39-.389a.977.977 0 0 0-1.382 0l-.465.465a.973.973 0 0 0 0 1.38l.383.383c.062.061.15.047.205-.014.226-.307.472-.601.746-.874.281-.28.568-.526.883-.751.068-.042.075-.137.02-.2m4.16 2.453v3.341c0 .096.104.165.192.117l2.97-1.537c.068-.034.089-.117.055-.184a3.695 3.695 0 0 0-3.08-1.866c-.068 0-.136.054-.136.13m0 8.048a4.489 4.489 0 0 1-4.49-4.482 4.488 4.488 0 0 1 4.49-4.482 4.488 4.488 0 0 1 4.489 4.482 4.484 4.484 0 0 1-4.49 4.482m0-10.85a6.363 6.363 0 1 0 0 12.729 6.37 6.37 0 0 0 6.372-6.368 6.358 6.358 0 0 0-6.371-6.36"})]})})})})]}),T.items.length>0?(0,x.jsx)("main",{children:T.items.map(((e,t)=>{let{title:r,url:n,summary:s,breadcrumbs:a}=e;return(0,x.jsxs)("article",{className:_.searchResultItem,children:[(0,x.jsx)(P.A,{as:"h2",className:_.searchResultItemHeading,children:(0,x.jsx)(f.A,{to:n,dangerouslySetInnerHTML:{__html:r}})}),a.length>0&&(0,x.jsx)("nav",{"aria-label":"breadcrumbs",children:(0,x.jsx)("ul",{className:(0,i.A)("breadcrumbs",_.searchResultItemPath),children:a.map(((e,t)=>(0,x.jsx)("li",{className:"breadcrumbs__item",dangerouslySetInnerHTML:{__html:e}},t)))})}),s&&(0,x.jsx)("p",{className:_.searchResultItemSummary,dangerouslySetInnerHTML:{__html:s}})]},t)}))}):[S&&!T.loading&&(0,x.jsx)("p",{children:(0,x.jsx)(y.A,{id:"theme.SearchPage.noResultsText",description:"The paragraph for empty search result",children:"No results were found"})},"no-results"),!!T.loading&&(0,x.jsx)("div",{className:_.loadingSpinner},"spinner")],T.hasMore&&(0,x.jsx)("div",{className:_.loader,ref:k,children:(0,x.jsx)(y.A,{id:"theme.SearchPage.fetchingNewResults",description:"The paragraph for fetching new search results",children:"Fetching new results..."})})]})]})}function w(){return(0,x.jsx)(g.e3,{className:"search-page-wrapper",children:(0,x.jsx)(O,{})})}}}]); \ No newline at end of file diff --git a/assets/js/1c28c6e3.af70b836.js b/assets/js/1c28c6e3.af70b836.js deleted file mode 100644 index 39cec56a60..0000000000 --- a/assets/js/1c28c6e3.af70b836.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1530],{9884:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var s=t(4848),a=t(8453);const i={title:"Custom Code",sidebar_position:2},o="Installation",r={id:"get-started/installation",title:"Custom Code",description:"Standard Installation",source:"@site/docs/get-started/installation.md",sourceDirName:"get-started",slug:"/get-started/installation",permalink:"/docs/get-started/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/installation.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Custom Code",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Docker",permalink:"/docs/get-started/docker"},next:{title:"Link Code Login",permalink:"/docs/get-started/link-code"}},l={},c=[{value:"Standard Installation",id:"standard-installation",level:2},{value:"CentOS Installation",id:"centos-installation",level:2},{value:"Installation when primarily using Chrome",id:"installation-when-primarily-using-chrome",level:2},{value:"Chrome issues on Linux based systems",id:"chrome-issues-on-linux-based-systems",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"installation",children:"Installation"}),"\n",(0,s.jsx)(n.h2,{id:"standard-installation",children:"Standard Installation"}),"\n",(0,s.jsx)(n.p,{children:"Run the following command to ensure you have wa-automate installed:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate\n"})}),"\n",(0,s.jsx)(n.p,{children:"or using yarn:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> yarn add @open-wa/wa-automate\n"})}),"\n",(0,s.jsx)(n.p,{children:"You can then add the library to your project:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"import { create, Client, decryptMedia, ev } from '@open-wa/wa-automate';\n\n"})}),"\n",(0,s.jsx)(n.h2,{id:"centos-installation",children:"CentOS Installation"}),"\n",(0,s.jsx)(n.p,{children:"Some people report CentOS causing problems when installing this library."}),"\n",(0,s.jsx)(n.p,{children:"Try the following:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate --unsafe-perm\n"})}),"\n",(0,s.jsx)(n.p,{children:"or if you come accros permission issues:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> sudo npm install @open-wa/wa-automate --unsafe-perm\n"})}),"\n",(0,s.jsx)(n.h2,{id:"installation-when-primarily-using-chrome",children:"Installation when primarily using Chrome"}),"\n",(0,s.jsxs)(n.p,{children:["If you use chrome, by setting ",(0,s.jsx)(n.a,{href:"/docs/api/interfaces/api.ConfigObject#useChrome",children:(0,s.jsx)(n.code,{children:"useChrome"})})," or ",(0,s.jsx)(n.a,{href:"/docs/api/interfaces/api.ConfigObject#executablepath",children:(0,s.jsx)(n.code,{children:"executablePath"})})," then you don't need to install the whole of puppeteer (puppeteer installs a version of Chromium - not Chrome - by default)."]}),"\n",(0,s.jsx)(n.p,{children:"If there are issues with installing the packages then try this:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate --ignore-scripts\n"})}),"\n",(0,s.jsx)(n.p,{children:"Doing this saves time and memory."}),"\n",(0,s.jsx)(n.h2,{id:"chrome-issues-on-linux-based-systems",children:"Chrome issues on Linux based systems"}),"\n",(0,s.jsxs)(n.p,{children:["Some people report issues with running the program using the built in puppeteer chromium package. Use this to install dependencies and install chrome. After doing the following command you can use Chrome by setting ",(0,s.jsx)(n.code,{children:"useChrome: true"})," in the config or with the ",(0,s.jsx)(n.code,{children:"--use-chrome"})," flag with the CLI."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb\n> sudo apt install ./google-chrome-stable_current_amd64.deb\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var s=t(6540);const a={},i=s.createContext(a);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1c28c6e3.be8a3dc0.js b/assets/js/1c28c6e3.be8a3dc0.js new file mode 100644 index 0000000000..26ee0254b0 --- /dev/null +++ b/assets/js/1c28c6e3.be8a3dc0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1530],{9884:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(4848),a=t(8453);const i={title:"Custom Code",sidebar_position:2},o="Installation",r={id:"get-started/installation",title:"Custom Code",description:"Standard Installation",source:"@site/docs/get-started/installation.md",sourceDirName:"get-started",slug:"/get-started/installation",permalink:"/docs/get-started/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/installation.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Custom Code",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Docker",permalink:"/docs/get-started/docker"},next:{title:"Link Code Login",permalink:"/docs/get-started/link-code"}},l={},d=[{value:"Standard Installation",id:"standard-installation",level:2},{value:"CentOS Installation",id:"centos-installation",level:2},{value:"Installation when primarily using Chrome",id:"installation-when-primarily-using-chrome",level:2},{value:"Chrome issues on Linux based systems",id:"chrome-issues-on-linux-based-systems",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"installation",children:"Installation"})}),"\n",(0,s.jsx)(n.h2,{id:"standard-installation",children:"Standard Installation"}),"\n",(0,s.jsx)(n.p,{children:"Run the following command to ensure you have wa-automate installed:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate\n"})}),"\n",(0,s.jsx)(n.p,{children:"or using yarn:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> yarn add @open-wa/wa-automate\n"})}),"\n",(0,s.jsx)(n.p,{children:"You can then add the library to your project:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"import { create, Client, decryptMedia, ev } from '@open-wa/wa-automate';\n\n"})}),"\n",(0,s.jsx)(n.h2,{id:"centos-installation",children:"CentOS Installation"}),"\n",(0,s.jsx)(n.p,{children:"Some people report CentOS causing problems when installing this library."}),"\n",(0,s.jsx)(n.p,{children:"Try the following:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate --unsafe-perm\n"})}),"\n",(0,s.jsx)(n.p,{children:"or if you come accros permission issues:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> sudo npm install @open-wa/wa-automate --unsafe-perm\n"})}),"\n",(0,s.jsx)(n.h2,{id:"installation-when-primarily-using-chrome",children:"Installation when primarily using Chrome"}),"\n",(0,s.jsxs)(n.p,{children:["If you use chrome, by setting ",(0,s.jsx)(n.a,{href:"/docs/api/interfaces/api.ConfigObject#useChrome",children:(0,s.jsx)(n.code,{children:"useChrome"})})," or ",(0,s.jsx)(n.a,{href:"/docs/api/interfaces/api.ConfigObject#executablepath",children:(0,s.jsx)(n.code,{children:"executablePath"})})," then you don't need to install the whole of puppeteer (puppeteer installs a version of Chromium - not Chrome - by default)."]}),"\n",(0,s.jsx)(n.p,{children:"If there are issues with installing the packages then try this:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> npm install @open-wa/wa-automate --ignore-scripts\n"})}),"\n",(0,s.jsx)(n.p,{children:"Doing this saves time and memory."}),"\n",(0,s.jsx)(n.h2,{id:"chrome-issues-on-linux-based-systems",children:"Chrome issues on Linux based systems"}),"\n",(0,s.jsxs)(n.p,{children:["Some people report issues with running the program using the built in puppeteer chromium package. Use this to install dependencies and install chrome. After doing the following command you can use Chrome by setting ",(0,s.jsx)(n.code,{children:"useChrome: true"})," in the config or with the ",(0,s.jsx)(n.code,{children:"--use-chrome"})," flag with the CLI."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"> wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb\n> sudo apt install ./google-chrome-stable_current_amd64.deb\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var s=t(6540);const a={},i=s.createContext(a);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1df732fe.3ac3c63e.js b/assets/js/1df732fe.3ac3c63e.js new file mode 100644 index 0000000000..2c93088feb --- /dev/null +++ b/assets/js/1df732fe.3ac3c63e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57],{7725:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=i(4848),c=i(8453);const o={},s="api/model/config",a={id:"reference/api/model/config/index",title:"api/model/config",description:"Index",source:"@site/docs/reference/api/model/config/index.md",sourceDirName:"reference/api/model/config",slug:"/reference/api/model/config/",permalink:"/docs/reference/api/model/config/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration"},next:{title:"Enumeration: CLOUD\\_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS"}},l={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function t(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelconfig",children:"api/model/config"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(t,{...e})}):t(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>a});var r=i(6540);const c={},o=r.createContext(c);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1df732fe.f3852e83.js b/assets/js/1df732fe.f3852e83.js deleted file mode 100644 index 50cd261338..0000000000 --- a/assets/js/1df732fe.f3852e83.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57],{7725:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=i(4848),c=i(8453);const o={},s="api/model/config",a={id:"reference/api/model/config/index",title:"api/model/config",description:"Index",source:"@site/docs/reference/api/model/config/index.md",sourceDirName:"reference/api/model/config",slug:"/reference/api/model/config/",permalink:"/docs/reference/api/model/config/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration"},next:{title:"Enumeration: CLOUD\\_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS"}},l={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function t(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodelconfig",children:"api/model/config"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(t,{...e})}):t(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>a});var r=i(6540);const c={},o=r.createContext(c);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1df93b7f.934745b4.js b/assets/js/1df93b7f.8004974f.js similarity index 97% rename from assets/js/1df93b7f.934745b4.js rename to assets/js/1df93b7f.8004974f.js index 61f997830c..62e304736f 100644 --- a/assets/js/1df93b7f.934745b4.js +++ b/assets/js/1df93b7f.8004974f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4583],{870:(e,a,t)=>{t.d(a,{A:()=>c});var r,l=t(6540);function n(){return n=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...c}=e;return l.createElement("svg",n({xmlns:"http://www.w3.org/2000/svg",width:1088,height:687.962,viewBox:"0 0 1088 687.962","aria-labelledby":t},c),void 0===a?l.createElement("title",{id:t},"Easy to Use"):a?l.createElement("title",{id:t},a):null,r||(r=l.createElement("g",{"data-name":"Group 12"},l.createElement("g",{"data-name":"Group 11"},l.createElement("path",{fill:"#3f3d56",d:"M961.81 454.442c-5.27 45.15-16.22 81.4-31.25 110.31-20 38.52-54.21 54.04-84.77 70.28a193 193 0 0 1-27.46 11.94c-55.61 19.3-117.85 14.18-166.74 3.99a657 657 0 0 0-104.09-13.16q-14.97-.675-29.97-.67c-15.42.02-293.07 5.29-360.67-131.57-16.69-33.76-28.13-75-32.24-125.27-11.63-142.12 52.29-235.46 134.74-296.47 155.97-115.41 369.76-110.57 523.43 7.88 102.36 78.9 198.2 198.31 179.02 362.74","data-name":"Path 83"}),l.createElement("path",{fill:"#f2f2f2",d:"M930.56 564.752c-20 38.52-47.21 64.04-77.77 80.28a193 193 0 0 1-27.46 11.94c-55.61 19.3-117.85 14.18-166.74 3.99a657 657 0 0 0-104.09-13.16q-14.97-.675-29.97-.67-23.13.03-46.25 1.72c-100.17 7.36-253.82-6.43-321.42-143.29L326 177.962l62.95 161.619 20.09 51.59 55.37-75.98L493 275.962l130.2 149.27 36.8-81.27 254.78 207.919 14.21 11.59Z","data-name":"Path 84"}),l.createElement("path",{d:"m302 282.962 26-57 36 83-31-60Z","data-name":"Path 85",opacity:.1}),l.createElement("path",{d:"M554.5 647.802q-14.97-.675-29.97-.67l-115.49-255.96Z","data-name":"Path 86",opacity:.1}),l.createElement("path",{d:"M464.411 315.191 493 292.962l130 150-132-128Z","data-name":"Path 87",opacity:.1}),l.createElement("path",{d:"M852.79 645.032a193 193 0 0 1-27.46 11.94L623.2 425.232Z","data-name":"Path 88",opacity:.1}),l.createElement("circle",{cx:3,cy:3,r:3,fill:"#f2f2f2","data-name":"Ellipse 11",transform:"translate(479 98.962)"}),l.createElement("circle",{cx:3,cy:3,r:3,fill:"#f2f2f2","data-name":"Ellipse 12",transform:"translate(396 201.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 13",transform:"translate(600 220.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 14",transform:"translate(180 265.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 15",transform:"translate(612 96.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 16",transform:"translate(736 192.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 17",transform:"translate(858 344.962)"}),l.createElement("path",{fill:"#f2f2f2",d:"M306 121.222h-2.76v-2.76h-1.48v2.76H299v1.478h2.76v2.759h1.48V122.7H306Z","data-name":"Path 89"}),l.createElement("path",{fill:"#f2f2f2",d:"M848 424.222h-2.76v-2.76h-1.48v2.76H841v1.478h2.76v2.759h1.48V425.7H848Z","data-name":"Path 90"}),l.createElement("path",{fill:"#3f3d56",d:"M1088 613.962c0 16.569-243.557 74-544 74s-544-57.431-544-74 243.557 14 544 14 544-30.568 544-14","data-name":"Path 91"}),l.createElement("path",{d:"M1088 613.962c0 16.569-243.557 74-544 74s-544-57.431-544-74 243.557 14 544 14 544-30.568 544-14","data-name":"Path 92",opacity:.1}),l.createElement("ellipse",{cx:544,cy:30,fill:"#3f3d56","data-name":"Ellipse 18",rx:544,ry:30,transform:"translate(0 583.962)"}),l.createElement("path",{fill:"#ff6584",d:"M568 571.962c0 33.137-14.775 24-33 24s-33 9.137-33-24 33-96 33-96 33 62.863 33 96","data-name":"Path 93"}),l.createElement("path",{d:"M550 584.641c0 15.062-6.716 10.909-15 10.909s-15 4.153-15-10.909 15-43.636 15-43.636 15 28.576 15 43.636","data-name":"Path 94",opacity:.1}),l.createElement("rect",{width:92,height:18,fill:"#2f2e41","data-name":"Rectangle 97",rx:9,transform:"translate(489 604.962)"}),l.createElement("rect",{width:92,height:18,fill:"#2f2e41","data-name":"Rectangle 98",rx:9,transform:"translate(489 586.962)"}),l.createElement("path",{fill:"#3f3d56",d:"M137 490.528c0 55.343 34.719 100.126 77.626 100.126","data-name":"Path 95"}),l.createElement("path",{fill:"#6c63ff",d:"M214.626 590.654c0-55.965 38.745-101.251 86.626-101.251","data-name":"Path 96"}),l.createElement("path",{fill:"#6c63ff",d:"M165.125 495.545c0 52.57 22.14 95.109 49.5 95.109","data-name":"Path 97"}),l.createElement("path",{fill:"#3f3d56",d:"M214.626 590.654c0-71.511 44.783-129.377 100.126-129.377","data-name":"Path 98"}),l.createElement("path",{fill:"#a8a8a8",d:"M198.3 591.36s11.009-.339 14.326-2.7 16.934-5.183 17.757-1.395 16.544 18.844 4.115 18.945-28.879-1.936-32.19-3.953-4.008-10.897-4.008-10.897","data-name":"Path 99"}),l.createElement("path",{d:"M234.716 604.89c-12.429.1-28.879-1.936-32.19-3.953-2.522-1.536-3.527-7.048-3.863-9.591l-.368.014s.7 8.879 4.009 10.9 19.761 4.053 32.19 3.953c3.588-.029 4.827-1.305 4.759-3.2-.498 1.142-1.867 1.855-4.537 1.877","data-name":"Path 100",opacity:.2}),l.createElement("path",{fill:"#3f3d56",d:"M721.429 527.062c0 38.029 23.857 68.8 53.341 68.8","data-name":"Path 101"}),l.createElement("path",{fill:"#6c63ff",d:"M774.769 595.863c0-38.456 26.623-69.575 59.525-69.575","data-name":"Path 102"}),l.createElement("path",{fill:"#6c63ff",d:"M740.755 530.509c0 36.124 15.213 65.354 34.014 65.354","data-name":"Path 103"}),l.createElement("path",{fill:"#3f3d56",d:"M774.769 595.863c0-49.139 30.773-88.9 68.8-88.9","data-name":"Path 104"}),l.createElement("path",{fill:"#a8a8a8",d:"M763.548 596.348s7.565-.233 9.844-1.856 11.636-3.562 12.2-.958 11.368 12.949 2.828 13.018-19.844-1.33-22.119-2.716-2.753-7.488-2.753-7.488","data-name":"Path 105"}),l.createElement("path",{d:"M788.574 605.645c-8.54.069-19.844-1.33-22.119-2.716-1.733-1.056-2.423-4.843-2.654-6.59l-.253.01s.479 6.1 2.755 7.487 13.579 2.785 22.119 2.716c2.465-.02 3.317-.9 3.27-2.2-.343.788-1.283 1.278-3.118 1.293","data-name":"Path 106",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M893.813 618.699s11.36-1.729 14.5-4.591 16.89-7.488 18.217-3.667 19.494 17.447 6.633 19.107-30.153 1.609-33.835-.065-5.515-10.784-5.515-10.784","data-name":"Path 107"}),l.createElement("path",{d:"M933.228 628.154c-12.86 1.659-30.153 1.609-33.835-.065-2.8-1.275-4.535-6.858-5.2-9.45l-.379.061s1.833 9.109 5.516 10.783 20.975 1.725 33.835.065c3.712-.479 4.836-1.956 4.529-3.906-.375 1.246-1.703 2.156-4.466 2.512","data-name":"Path 108",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M614.26 617.881s9.587-1.459 12.237-3.875 14.255-6.32 15.374-3.095 16.452 14.725 5.6 16.125-25.448 1.358-28.555-.055-4.656-9.1-4.656-9.1","data-name":"Path 109"}),l.createElement("path",{d:"M647.524 625.856c-10.853 1.4-25.448 1.358-28.555-.055-2.367-1.076-3.827-5.788-4.39-7.976l-.32.051s1.547 7.687 4.655 9.1 17.7 1.456 28.555.055c3.133-.4 4.081-1.651 3.822-3.3-.314 1.057-1.435 1.825-3.767 2.125","data-name":"Path 110",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M122.389 613.09s7.463-1.136 9.527-3.016 11.1-4.92 11.969-2.409 12.808 11.463 4.358 12.553-19.811 1.057-22.23-.043-3.624-7.085-3.624-7.085","data-name":"Path 111"}),l.createElement("path",{d:"M148.285 619.302c-8.449 1.09-19.811 1.057-22.23-.043-1.842-.838-2.979-4.506-3.417-6.209l-.249.04s1.2 5.984 3.624 7.085 13.781 1.133 22.23.043c2.439-.315 3.177-1.285 2.976-2.566-.246.818-1.119 1.416-2.934 1.65","data-name":"Path 112",opacity:.2}),l.createElement("path",{d:"M383.7 601.318c0 30.22-42.124 20.873-93.7 20.873s-93.074 9.347-93.074-20.873 42.118-36.793 93.694-36.793 93.08 6.573 93.08 36.793","data-name":"Path 113",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M383.7 593.881c0 30.22-42.124 20.873-93.7 20.873s-93.074 9.347-93.074-20.873 42.114-36.8 93.69-36.8 93.084 6.576 93.084 36.8","data-name":"Path 114"})),l.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M360.175 475.732h91.791v37.153h-91.791Z","data-name":"Path 40"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M277.126 597.026a21.83 21.83 0 0 1-18.908-10.927 21.829 21.829 0 0 0 18.908 32.782h21.855v-21.855Z","data-name":"Path 41"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m375.451 481.607 76.514-4.782v-10.928a21.854 21.854 0 0 0-21.855-21.855h-98.347l-2.732-4.735a3.154 3.154 0 0 0-5.464 0l-2.732 4.732-2.732-4.732a3.154 3.154 0 0 0-5.464 0l-2.732 4.732-2.731-4.732a3.154 3.154 0 0 0-5.464 0l-2.732 4.735h-.071l-4.526-4.525a3.153 3.153 0 0 0-5.276 1.414l-1.5 5.577-5.674-1.521a3.154 3.154 0 0 0-3.863 3.864l1.52 5.679-5.575 1.494a3.155 3.155 0 0 0-1.416 5.278l4.526 4.526v.07l-4.735 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.727a3.154 3.154 0 0 0 0 5.464l4.735 2.736-4.735 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.735a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.728a3.154 3.154 0 0 0 0 5.464l4.732 2.732a21.854 21.854 0 0 0 21.858 21.855h131.13a21.854 21.854 0 0 0 21.855-21.855v-87.42l-76.514-4.782a11.632 11.632 0 0 1 0-23.219","data-name":"Path 42"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M408.255 618.882h32.782v-43.71h-32.782Z","data-name":"Path 43"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M462.893 591.563a5 5 0 0 0-.7.07c-.042-.164-.081-.329-.127-.493a5.457 5.457 0 1 0-5.4-9.372q-.181-.185-.366-.367a5.454 5.454 0 1 0-9.384-5.4c-.162-.046-.325-.084-.486-.126a5.467 5.467 0 1 0-10.788 0c-.162.042-.325.08-.486.126a5.457 5.457 0 1 0-9.384 5.4 21.843 21.843 0 1 0 36.421 21.02 5.452 5.452 0 1 0 .7-10.858","data-name":"Path 44"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M419.183 553.317h32.782v-21.855h-32.782Z","data-name":"Path 45"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M462.893 545.121a2.732 2.732 0 1 0 0-5.464 3 3 0 0 0-.349.035c-.022-.082-.04-.164-.063-.246a2.733 2.733 0 0 0-1.052-5.253 2.7 2.7 0 0 0-1.648.566q-.09-.093-.184-.184a2.7 2.7 0 0 0 .553-1.633 2.732 2.732 0 0 0-5.245-1.07 10.928 10.928 0 1 0 0 21.031 2.732 2.732 0 0 0 5.245-1.07 2.7 2.7 0 0 0-.553-1.633q.093-.09.184-.184a2.7 2.7 0 0 0 1.648.566 2.732 2.732 0 0 0 1.052-5.253q.033-.122.063-.246a3 3 0 0 0 .349.035","data-name":"Path 46"}),l.createElement("path",{fillRule:"evenodd",d:"M320.836 479.556a2.73 2.73 0 0 1-2.732-2.732 8.2 8.2 0 0 0-16.391 0 2.732 2.732 0 0 1-5.464 0 13.66 13.66 0 0 1 27.319 0 2.73 2.73 0 0 1-2.732 2.732","data-name":"Path 47"}),l.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M364.546 618.881h65.565a21.854 21.854 0 0 0 21.855-21.855v-76.492h-65.565a21.854 21.854 0 0 0-21.855 21.855Z","data-name":"Path 48"}),l.createElement("path",{fillRule:"evenodd",d:"M435.596 554.41h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0-54.434h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0 21.652h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m16.369-100.959c-.013 0-.024-.007-.037-.005-3.377.115-4.974 3.492-6.384 6.472-1.471 3.114-2.608 5.139-4.473 5.078-2.064-.074-3.244-2.406-4.494-4.874-1.436-2.835-3.075-6.049-6.516-5.929-3.329.114-4.932 3.053-6.346 5.646-1.5 2.762-2.529 4.442-4.5 4.364-2.106-.076-3.225-1.972-4.52-4.167-1.444-2.443-3.112-5.191-6.487-5.1-3.272.113-4.879 2.606-6.3 4.808-1.5 2.328-2.552 3.746-4.551 3.662-2.156-.076-3.27-1.65-4.558-3.472-1.447-2.047-3.077-4.363-6.442-4.251-3.2.109-4.807 2.153-6.224 3.954-1.346 1.709-2.4 3.062-4.621 2.977a1.094 1.094 0 0 0-.079 2.186c3.3.11 4.967-1.967 6.417-3.81 1.286-1.635 2.4-3.045 4.582-3.12 2.1-.09 3.091 1.218 4.584 3.327 1.417 2 3.026 4.277 6.263 4.394 3.391.114 5.022-2.42 6.467-4.663 1.292-2 2.406-3.734 4.535-3.807 1.959-.073 3.026 1.475 4.529 4.022 1.417 2.4 3.023 5.121 6.324 5.241 3.415.118 5.064-2.863 6.5-5.5 1.245-2.282 2.419-4.437 4.5-4.509 1.959-.046 2.981 1.743 4.492 4.732 1.412 2.79 3.013 5.95 6.365 6.071h.185c3.348 0 4.937-3.36 6.343-6.331 1.245-2.634 2.423-5.114 4.444-5.216Z","data-name":"Path 49"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M342.691 618.882h43.71v-43.71h-43.71Z","data-name":"Path 50"}),l.createElement("g",{"data-name":"Group 8",transform:"rotate(-14.98 2188.845 -1120.376)"},l.createElement("rect",{width:92.361,height:36.462,fill:"#d8d8d8","data-name":"Rectangle 3",rx:2}),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 2",transform:"translate(1.531 23.03)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 4",rx:1,transform:"translate(16.797)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 5",rx:1,transform:"translate(23.12)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 6",rx:1,transform:"translate(29.444)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 7",rx:1,transform:"translate(35.768)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 8",rx:1,transform:"translate(42.091)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 9",rx:1,transform:"translate(48.415)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 10",rx:1,transform:"translate(54.739)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 11",rx:1,transform:"translate(61.063)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 12",rx:1,transform:"translate(67.386)"}),l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h13.425a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H1.093A1.093 1.093 0 0 1 0 4.243v-3.15A1.093 1.093 0 0 1 1.093 0M75 0h13.426a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H75a1.093 1.093 0 0 1-1.093-1.093v-3.15A1.093 1.093 0 0 1 75 0","data-name":"Path 51"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 3",transform:"translate(1.531 10.261)"},l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h5.125A1.093 1.093 0 0 1 7.31 1.093v3.149a1.093 1.093 0 0 1-1.092 1.093H1.093A1.093 1.093 0 0 1 0 4.242V1.093A1.093 1.093 0 0 1 1.093 0","data-name":"Path 52"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 13",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 14",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 15",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 16",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 17",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 18",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 19",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 20",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 21",rx:1,transform:"translate(58.888)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 22",rx:1,transform:"translate(65.212)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 23",rx:1,transform:"translate(71.536)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 24",rx:1,transform:"translate(77.859)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 25",rx:1,transform:"translate(84.183)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 4",transform:"rotate(180 45.525 4.773)"},l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h5.126a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H1.093A1.093 1.093 0 0 1 0 4.243v-3.15A1.093 1.093 0 0 1 1.093 0","data-name":"Path 53"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 26",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 27",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 28",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 29",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 30",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 31",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 32",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 33",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 34",rx:1,transform:"translate(58.889)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 35",rx:1,transform:"translate(65.213)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 36",rx:1,transform:"translate(71.537)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 37",rx:1,transform:"translate(77.86)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 38",rx:1,transform:"translate(84.183)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 39",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 40",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 41",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 42",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 43",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 44",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 45",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 46",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 47",rx:1,transform:"translate(58.889)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 48",rx:1,transform:"translate(65.213)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 49",rx:1,transform:"translate(71.537)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 50",rx:1,transform:"translate(77.86)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 51",rx:1,transform:"translate(84.183)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 6"},l.createElement("path",{fillRule:"evenodd",d:"M2.624 16.584h7.3a1.093 1.093 0 0 1 1.092 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093h-7.3a1.093 1.093 0 0 1-1.092-1.093v-3.149a1.093 1.093 0 0 1 1.093-1.094","data-name":"Path 54"}),l.createElement("g",{"data-name":"Group 5",transform:"translate(12.202 16.584)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 52",rx:1}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 53",rx:1,transform:"translate(6.324)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 54",rx:1,transform:"translate(12.647)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 55",rx:1,transform:"translate(18.971)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 56",rx:1,transform:"translate(25.295)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 57",rx:1,transform:"translate(31.619)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 58",rx:1,transform:"translate(37.942)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 59",rx:1,transform:"translate(44.265)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 60",rx:1,transform:"translate(50.589)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 61",rx:1,transform:"translate(56.912)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 62",rx:1,transform:"translate(63.236)"})),l.createElement("path",{fillRule:"evenodd",d:"M83.053 16.584h6.906a1.093 1.093 0 0 1 1.091 1.093v3.15a1.093 1.093 0 0 1-1.091 1.093h-6.907a1.093 1.093 0 0 1-1.093-1.093v-3.149a1.093 1.093 0 0 1 1.093-1.094Z","data-name":"Path 55"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 7",transform:"translate(1.531 29.627)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 63",rx:1}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 64",rx:1,transform:"translate(6.324)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 65",rx:1,transform:"translate(12.647)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 66",rx:1,transform:"translate(18.971)"}),l.createElement("path",{fillRule:"evenodd",d:"M26.387 0h30.422a1.093 1.093 0 0 1 1.093 1.093v3.151a1.093 1.093 0 0 1-1.093 1.093H26.387a1.093 1.093 0 0 1-1.093-1.093V1.093A1.093 1.093 0 0 1 26.387 0m33.594 0h3.942a1.093 1.093 0 0 1 1.093 1.093v3.151a1.093 1.093 0 0 1-1.093 1.093h-3.942a1.093 1.093 0 0 1-1.093-1.093V1.093A1.093 1.093 0 0 1 59.981 0","data-name":"Path 56"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 67",rx:1,transform:"translate(66.003)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 68",rx:1,transform:"translate(72.327)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 69",rx:1,transform:"translate(84.183)"}),l.createElement("path",{d:"M78.254 2.273v-1.18A1.093 1.093 0 0 1 79.347 0h3.15a1.093 1.093 0 0 1 1.093 1.093v1.18Z","data-name":"Path 57"}),l.createElement("path",{d:"M83.591 3.063v1.18a1.093 1.093 0 0 1-1.093 1.093h-3.15a1.093 1.093 0 0 1-1.093-1.093v-1.18Z","data-name":"Path 58"})),l.createElement("rect",{width:88.927,height:2.371,fill:"#4a4a4a","data-name":"Rectangle 70",rx:1.085,transform:"translate(1.925 1.17)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 71",opacity:.136,rx:.723,transform:"translate(4.1 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 72",opacity:.136,rx:.723,transform:"translate(10.923 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 73",opacity:.136,rx:.723,transform:"translate(16.173 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 74",opacity:.136,rx:.723,transform:"translate(21.421 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 75",opacity:.136,rx:.723,transform:"translate(26.671 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 76",opacity:.136,rx:.723,transform:"translate(33.232 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 77",opacity:.136,rx:.723,transform:"translate(38.48 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 78",opacity:.136,rx:.723,transform:"translate(43.73 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 79",opacity:.136,rx:.723,transform:"translate(48.978 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 80",opacity:.136,rx:.723,transform:"translate(55.54 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 81",opacity:.136,rx:.723,transform:"translate(60.788 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 82",opacity:.136,rx:.723,transform:"translate(66.038 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 83",opacity:.136,rx:.723,transform:"translate(72.599 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 84",opacity:.136,rx:.723,transform:"translate(77.847 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 85",opacity:.136,rx:.723,transform:"translate(83.097 1.566)"})),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M408.256 591.563a5.4 5.4 0 0 0-.7.07c-.042-.164-.081-.329-.127-.493a5.457 5.457 0 1 0-5.4-9.372q-.181-.185-.366-.367a5.454 5.454 0 1 0-9.384-5.4c-.162-.046-.325-.084-.486-.126a5.467 5.467 0 1 0-10.788 0c-.162.042-.325.08-.486.126a5.457 5.457 0 1 0-9.384 5.4 21.843 21.843 0 1 0 36.421 21.02 5.452 5.452 0 1 0 .7-10.858","data-name":"Path 59"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M342.691 553.317h43.71v-21.855h-43.71Z","data-name":"Path 60"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M397.328 545.121a2.732 2.732 0 1 0 0-5.464 3 3 0 0 0-.349.035c-.022-.082-.04-.164-.063-.246a2.733 2.733 0 0 0-1.052-5.253 2.7 2.7 0 0 0-1.648.566q-.09-.093-.184-.184a2.7 2.7 0 0 0 .553-1.633 2.732 2.732 0 0 0-5.245-1.07 10.928 10.928 0 1 0 0 21.031 2.732 2.732 0 0 0 5.245-1.07 2.7 2.7 0 0 0-.553-1.633q.093-.09.184-.184a2.7 2.7 0 0 0 1.648.566 2.732 2.732 0 0 0 1.052-5.253q.033-.122.063-.246a3 3 0 0 0 .349.035","data-name":"Path 61"}),l.createElement("path",{fillRule:"evenodd",d:"M408.256 464.531a3 3 0 0 1-.535-.055 2.8 2.8 0 0 1-.514-.153 3 3 0 0 1-.471-.251 4 4 0 0 1-.415-.339 3 3 0 0 1-.338-.415 2.7 2.7 0 0 1-.459-1.517 3 3 0 0 1 .055-.535 3 3 0 0 1 .152-.514 3 3 0 0 1 .252-.47 2.6 2.6 0 0 1 .753-.754 3 3 0 0 1 .471-.251 2.8 2.8 0 0 1 .514-.153 2.5 2.5 0 0 1 1.071 0 2.7 2.7 0 0 1 .983.4 4 4 0 0 1 .415.339 4 4 0 0 1 .339.415 3 3 0 0 1 .251.47 2.9 2.9 0 0 1 .208 1.049 2.77 2.77 0 0 1-.8 1.934 4 4 0 0 1-.415.339 2.72 2.72 0 0 1-1.519.459m21.855-1.366a2.8 2.8 0 0 1-1.935-.8 4 4 0 0 1-.338-.415 2.7 2.7 0 0 1-.459-1.519 2.8 2.8 0 0 1 .8-1.934 4 4 0 0 1 .415-.339 3 3 0 0 1 .471-.251 2.8 2.8 0 0 1 .514-.153 2.5 2.5 0 0 1 1.071 0 2.7 2.7 0 0 1 .983.4 4 4 0 0 1 .415.339 2.8 2.8 0 0 1 .8 1.934 3 3 0 0 1-.055.535 3 3 0 0 1-.153.514 4 4 0 0 1-.251.47 4 4 0 0 1-.339.415 4 4 0 0 1-.415.339 2.72 2.72 0 0 1-1.519.459","data-name":"Path 62"}))))}},6740:(e,a,t)=>{t.d(a,{A:()=>c});var r,l=t(6540);function n(){return n=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...c}=e;return l.createElement("svg",n({xmlns:"http://www.w3.org/2000/svg",width:1041.277,height:554.141,viewBox:"0 0 1041.277 554.141","aria-labelledby":t},c),void 0===a?l.createElement("title",{id:t},"Powered by React"):a?l.createElement("title",{id:t},a):null,r||(r=l.createElement("g",{"data-name":"Group 24"},l.createElement("g",{"data-name":"Group 23",transform:"translate(-.011 -.035)"},l.createElement("path",{fill:"#f2f2f2",d:"M961.48 438.21q-1.74 3.75-3.47 7.4-2.7 5.67-5.33 11.12c-.78 1.61-1.56 3.19-2.32 4.77-8.6 17.57-16.63 33.11-23.45 45.89a73.21 73.21 0 0 1-63.81 38.7l-151.65 1.65h-1.6l-13 .14-11.12.12-34.1.37h-1.38l-17.36.19h-.53l-107 1.16-95.51 1-11.11.12-69 .75h-.08l-44.75.48h-.48l-141.5 1.53-42.33.46a88 88 0 0 1-10.79-.54c-1.22-.14-2.44-.3-3.65-.49a87.38 87.38 0 0 1-51.29-27.54c-18.21-20.03-31.46-43.4-40.36-68.76q-1.93-5.49-3.6-11.12c-30.81-104.15 6.75-238.52 74.35-328.44q4.25-5.64 8.64-11l.07-.08c20.79-25.52 44.1-46.84 68.93-62 44-26.91 92.75-34.49 140.7-11.9 40.57 19.12 78.45 28.11 115.17 30.55 3.71.24 7.42.42 11.11.53 84.23 2.65 163.17-27.7 255.87-47.29 3.69-.78 7.39-1.55 11.12-2.28C763 .54 836.36-6.4 923.6 8.19a189 189 0 0 1 26.76 6.4q5.77 1.86 11.12 4c41.64 16.94 64.35 48.24 74 87.46q1.37 5.46 2.37 11.11c17.11 94.34-33 228.16-76.37 321.05","data-name":"Path 299"}),l.createElement("path",{d:"M497.02 445.61a95 95 0 0 1-1.87 11.12h93.7v-11.12Zm-78.25 62.81 11.11-.09v-27.47c-3.81-.17-7.52-.34-11.11-.52Zm-232.92-62.81v11.12h198.5v-11.12Zm849.68-339.52h-74V18.6q-5.35-2.17-11.12-4v91.49H696.87V13.67c-3.73.73-7.43 1.5-11.12 2.28v90.14H429.88V63.24c-3.69-.11-7.4-.29-11.11-.53v43.38H162.9v-62c-24.83 15.16-48.14 36.48-68.93 62h-.07v.08q-4.4 5.4-8.64 11h8.64v328.44h-83q1.66 5.63 3.6 11.12h79.39v93.62a87 87 0 0 0 12.2 2.79c1.21.19 2.43.35 3.65.49a88 88 0 0 0 10.79.54l42.33-.46v-97h255.91v94.21l11.11-.12v-94.07h255.87v91.36l11.12-.12v-91.24h253.49v4.77c.76-1.58 1.54-3.16 2.32-4.77q2.63-5.45 5.33-11.12 1.73-3.64 3.47-7.4v-321h76.42q-1.01-5.69-2.37-11.12M162.9 445.61V117.17h255.87v328.44Zm267 0V117.17h255.85v328.44Zm520.48 0H696.87V117.17h253.49Z","data-name":"Path 300",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l46.65-28 93.6-.78 2-.01.66-.01 2-.03 44.94-.37 2.01-.01.64-.01 2-.01 14.41-.12.38-.01 35.55-.3h.29l277.4-2.34 6.79-.05h.68l5.18-.05 37.65-.31 2-.03 1.85-.02h.96l11.71-.09 2.32-.03 3.11-.02 9.75-.09 15.47-.13 2-.02 3.48-.02h.65l74.71-.64Z","data-name":"Path 301"}),l.createElement("path",{d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l46.65-28 93.6-.78 2-.01.66-.01 2-.03 44.94-.37 2.01-.01.64-.01 2-.01 14.41-.12.38-.01 35.55-.3h.29l277.4-2.34 6.79-.05h.68l5.18-.05 37.65-.31 2-.03 1.85-.02h.96l11.71-.09 2.32-.03 3.11-.02 9.75-.09 15.47-.13 2-.02 3.48-.02h.65l74.71-.64Z","data-name":"Path 302",opacity:.2}),l.createElement("path",{fill:"#3f3d56",d:"M296.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 303"}),l.createElement("path",{d:"M296.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 304",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M298.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 305"}),l.createElement("path",{fill:"#3f3d56",d:"M680.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 137"}),l.createElement("path",{d:"M680.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 138",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M678.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 139"}),l.createElement("path",{d:"M298.09 483.65v4.97l-47.17 1.26v-6.23Z","data-name":"Path 306",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M381.35 312.36v168.2a4 4 0 0 1-3.85 3.95l-191.65 5.1h-.05a4 4 0 0 1-3.95-3.95v-173.3a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.95 3.95","data-name":"Path 307"}),l.createElement("path",{d:"M185.85 308.41v181.2h-.05a4 4 0 0 1-3.95-3.95v-173.3a4 4 0 0 1 3.95-3.95Z","data-name":"Path 308",opacity:.1}),l.createElement("path",{fill:"#39374d",d:"M194.59 319.15h177.5V467.4l-177.5 4Z","data-name":"Path 309"}),l.createElement("path",{d:"M726.09 483.65v6.41l-47.17-1.26v-5.15Z","data-name":"Path 310",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M788.35 312.36v173.3a4 4 0 0 1-4 3.95l-191.69-5.1a4 4 0 0 1-3.85-3.95v-168.2a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.99 3.95","data-name":"Path 311"}),l.createElement("path",{d:"M788.35 312.36v173.3a4 4 0 0 1-4 3.95v-181.2a4 4 0 0 1 4 3.95","data-name":"Path 312",opacity:.1}),l.createElement("path",{fill:"#39374d",d:"M775.59 319.15h-177.5V467.4l177.5 4Z","data-name":"Path 313"}),l.createElement("path",{fill:"#65617d",d:"M583.85 312.36v168.2a4 4 0 0 1-3.85 3.95l-191.65 5.1a4 4 0 0 1-4-3.95v-173.3a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.95 3.95","data-name":"Path 314"}),l.createElement("path",{fill:"#4267b2",d:"M397.09 319.15h177.5V467.4l-177.5 4Z","data-name":"Path 315"}),l.createElement("path",{d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l202.51-1.33h.48l40.99-.28h.19l283.08-1.87h.29l.17-.01h.47l4.79-.03h1.46l74.49-.5 4.4-.02.98-.01Z","data-name":"Path 316",opacity:.1}),l.createElement("circle",{cx:51.33,cy:51.33,r:51.33,fill:"#fbbebe","data-name":"Ellipse 111",transform:"translate(435.93 246.82)"}),l.createElement("path",{fill:"#fbbebe",d:"M538.6 377.16s-99.5 12-90 0c3.44-4.34 4.39-17.2 4.2-31.85-.06-4.45-.22-9.06-.45-13.65-1.1-22-3.75-43.5-3.75-43.5s87-41 77-8.5c-4 13.13-2.69 31.57.35 48.88.89 5.05 1.92 10 3 14.7a345 345 0 0 0 9.65 33.92","data-name":"Path 317"}),l.createElement("path",{fill:"#ff6584",d:"M506.13 373.09c11.51-2.13 23.7-6 34.53-1.54 2.85 1.17 5.47 2.88 8.39 3.86s6.12 1.22 9.16 1.91c10.68 2.42 19.34 10.55 24.9 20s8.44 20.14 11.26 30.72l6.9 25.83c6 22.45 12 45.09 13.39 68.3a2438 2438 0 0 1-250.84 1.43c5.44-10.34 11-21.31 10.54-33s-7.19-23.22-4.76-34.74c1.55-7.34 6.57-13.39 9.64-20.22 8.75-19.52 1.94-45.79 17.32-60.65 6.92-6.68 17-9.21 26.63-8.89 12.28.41 24.85 4.24 37 6.11 15.56 2.36 30.26 3.76 45.94.88","data-name":"Path 318"}),l.createElement("path",{d:"m637.03 484.26-.1 1.43v.1l-.17 2.3-1.33 18.51-1.61 22.3-.46 6.28-1 13.44v.17l-107 1-175.59 1.9v.84h-.14v-1.12l.45-14.36.86-28.06.74-23.79.07-2.37a10.53 10.53 0 0 1 11.42-10.17c4.72.4 10.85.89 18.18 1.41l3 .22c42.33 2.94 120.56 6.74 199.5 2 1.66-.09 3.33-.19 5-.31 12.24-.77 24.47-1.76 36.58-3a10.53 10.53 0 0 1 11.6 11.23Z","data-name":"Path 319",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M349.74 552.53v-.84l175.62-1.91 107-1h.3v-.17l1-13.44.43-6 1.64-22.61 1.29-17.9v-.44a10.6 10.6 0 0 0-.11-2.47.3.3 0 0 0 0-.1 10.4 10.4 0 0 0-2-4.64 10.54 10.54 0 0 0-9.42-4 937 937 0 0 1-36.58 3c-1.67.12-3.34.22-5 .31-78.94 4.69-157.17.89-199.5-2l-3-.22c-7.33-.52-13.46-1-18.18-1.41a10.54 10.54 0 0 0-11.24 8.53 11 11 0 0 0-.18 1.64l-.68 22.16-.93 28.07-.44 14.36v1.12Z","data-name":"Path 320"}),l.createElement("path",{d:"m637.33 491.27-1.23 15.33-1.83 22.85-.46 5.72-1 12.81-.06.64v.17l-.15 1.48.11-1.48h-.29l-107 1-175.65 1.9v-.28l.49-14.36 1-28.06.64-18.65a6.36 6.36 0 0 1 3.06-5.25 6.25 6.25 0 0 1 3.78-.9c2.1.17 4.68.37 7.69.59 4.89.36 10.92.78 17.94 1.22 13 .82 29.31 1.7 48 2.42 52 2 122.2 2.67 188.88-3.17 3-.26 6.1-.55 9.13-.84a6.26 6.26 0 0 1 3.48.66 5 5 0 0 1 .86.54 6.14 6.14 0 0 1 2 2.46 3.6 3.6 0 0 1 .25.61 6.3 6.3 0 0 1 .36 2.59","data-name":"Path 321",opacity:.1}),l.createElement("path",{d:"M298.1 504.96v3.19a6.13 6.13 0 0 1-3.5 5.54l-40.1.77a6.12 6.12 0 0 1-3.57-5.57v-3Z","data-name":"Path 322",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m298.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 323"}),l.createElement("path",{d:"m298.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 324",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m300.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 325"}),l.createElement("path",{d:"M679.22 506.96v3.19a6.13 6.13 0 0 0 3.5 5.54l40.1.77a6.12 6.12 0 0 0 3.57-5.57v-3Z","data-name":"Path 326",opacity:.1}),l.createElement("path",{d:"m678.72 517.57 52.25 1v-8.67l-52.25-1Z","data-name":"Path 327",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m676.72 517.57 52.25 1v-8.67l-52.25-1Z","data-name":"Path 328"}),l.createElement("path",{fill:"#3f3d56",d:"M454.79 313.88c.08 7-3.16 13.6-5.91 20.07a163.5 163.5 0 0 0-12.66 74.71c.73 11 2.58 22 .73 32.9s-8.43 21.77-19 24.9c17.53 10.45 41.26 9.35 57.76-2.66 8.79-6.4 15.34-15.33 21.75-24.11a97.86 97.86 0 0 1-13.31 44.75 103.43 103.43 0 0 0 73.51-40.82c4.31-5.81 8.06-12.19 9.72-19.23 3.09-13-1.22-26.51-4.51-39.5a266 266 0 0 1-6.17-33c-.43-3.56-.78-7.22.1-10.7 1-4.07 3.67-7.51 5.64-11.22 5.6-10.54 5.73-23.3 2.86-34.88s-8.49-22.26-14.06-32.81c-4.46-8.46-9.3-17.31-17.46-22.28-5.1-3.1-11-4.39-16.88-5.64l-25.37-5.43c-5.55-1.19-11.26-2.38-16.87-1.51-9.47 1.48-16.14 8.32-22 15.34-4.59 5.46-15.81 15.71-16.6 22.86-.72 6.59 5.1 17.63 6.09 24.58 1.3 9 2.22 6 7.3 11.52 3.21 3.42 5.28 7.37 5.34 12.16","data-name":"Path 329"})),l.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M280.139 370.832h43.635v17.662h-43.635Z","data-name":"Path 40"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M240.66 428.493a10.38 10.38 0 0 1-8.989-5.195 10.377 10.377 0 0 0 8.988 15.584h10.391v-10.389Z","data-name":"Path 41"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m287.402 373.625 36.373-2.273v-5.195a10.39 10.39 0 0 0-10.39-10.389h-46.75l-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249h-.034l-2.152-2.151a1.5 1.5 0 0 0-2.508.672l-.696 2.653-2.7-.723a1.5 1.5 0 0 0-1.836 1.837l.722 2.7-2.65.71a1.5 1.5 0 0 0-.673 2.509l2.152 2.152v.033l-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.25 1.282-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3a10.39 10.39 0 0 0 10.389 10.34h62.335a10.39 10.39 0 0 0 10.39-10.39v-41.557l-36.373-2.273a5.53 5.53 0 0 1 0-11.038","data-name":"Path 42"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M302.996 438.882h15.584v-20.779h-15.584Z","data-name":"Path 43"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M328.97 425.895a3 3 0 0 0-.332.033q-.028-.117-.06-.234a2.594 2.594 0 1 0-2.567-4.455q-.086-.088-.174-.175a2.593 2.593 0 1 0-4.461-2.569q-.115-.031-.231-.06a2.6 2.6 0 1 0-5.128 0q-.116.029-.231.06a2.594 2.594 0 1 0-4.461 2.569 10.384 10.384 0 1 0 17.314 9.992 2.592 2.592 0 1 0 .332-5.161","data-name":"Path 44"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.191 407.713h15.584v-10.389h-15.584Z","data-name":"Path 45"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M328.969 403.818a1.3 1.3 0 1 0 0-2.6 1 1 0 0 0-.166.017l-.03-.117a1.3 1.3 0 0 0-.5-2.5 1.3 1.3 0 0 0-.783.269l-.087-.087a1.3 1.3 0 0 0 .263-.776 1.3 1.3 0 0 0-2.493-.509 5.195 5.195 0 1 0 0 10 1.3 1.3 0 0 0 2.493-.509 1.3 1.3 0 0 0-.263-.776l.087-.087a1.3 1.3 0 0 0 .783.269 1.3 1.3 0 0 0 .5-2.5q.016-.058.03-.117a1 1 0 0 0 .166.017","data-name":"Path 46"}),l.createElement("path",{fillRule:"evenodd",d:"M261.439 372.65a1.3 1.3 0 0 1-1.3-1.3 3.9 3.9 0 0 0-7.792 0 1.3 1.3 0 1 1-2.6 0 6.494 6.494 0 0 1 12.987 0 1.3 1.3 0 0 1-1.3 1.3","data-name":"Path 47"}),l.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M282.217 438.882h31.168a10.39 10.39 0 0 0 10.389-10.389V392.13h-31.168a10.39 10.39 0 0 0-10.389 10.389Z","data-name":"Path 48"}),l.createElement("path",{fillRule:"evenodd",d:"M315.993 408.233h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0-25.877h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.293h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m7.782-47.993h-.018c-1.605.055-2.365 1.66-3.035 3.077-.7 1.48-1.24 2.443-2.126 2.414-.981-.035-1.542-1.144-2.137-2.317-.683-1.347-1.462-2.876-3.1-2.819-1.582.054-2.344 1.451-3.017 2.684-.715 1.313-1.2 2.112-2.141 2.075-1-.036-1.533-.938-2.149-1.981-.686-1.162-1.479-2.467-3.084-2.423-1.555.053-2.319 1.239-2.994 2.286-.713 1.106-1.213 1.781-2.164 1.741-1.025-.036-1.554-.784-2.167-1.65-.688-.973-1.463-2.074-3.062-2.021a3.82 3.82 0 0 0-2.959 1.879c-.64.812-1.14 1.456-2.2 1.415a.52.52 0 0 0-.037 1.039 3.59 3.59 0 0 0 3.05-1.811c.611-.777 1.139-1.448 2.178-1.483 1-.043 1.47.579 2.179 1.582.674.953 1.438 2.033 2.977 2.089 1.612.054 2.387-1.151 3.074-2.217.614-.953 1.144-1.775 2.156-1.81.931-.035 1.438.7 2.153 1.912.674 1.141 1.437 2.434 3.006 2.491 1.623.056 2.407-1.361 3.09-2.616.592-1.085 1.15-2.109 2.14-2.143.931-.022 1.417.829 2.135 2.249.671 1.326 1.432 2.828 3.026 2.886h.088c1.592 0 2.347-1.6 3.015-3.01.592-1.252 1.152-2.431 2.113-2.479Z","data-name":"Path 49"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M271.828 438.882h20.779v-20.779h-20.779Z","data-name":"Path 50"}),l.createElement("g",{"data-name":"Group 8",transform:"rotate(-14.98 1643.944 -873.93)"},l.createElement("rect",{width:43.906,height:17.333,fill:"#d8d8d8","data-name":"Rectangle 3",rx:2}),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 2",transform:"translate(.728 10.948)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 4",rx:1,transform:"translate(7.985)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 5",rx:1,transform:"translate(10.991)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 6",rx:1,transform:"translate(13.997)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 7",rx:1,transform:"translate(17.003)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 8",rx:1,transform:"translate(20.009)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 9",rx:1,transform:"translate(23.015)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 10",rx:1,transform:"translate(26.021)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 11",rx:1,transform:"translate(29.028)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 12",rx:1,transform:"translate(32.034)"}),l.createElement("path",{fillRule:"evenodd",d:"M.519 0H6.9a.52.52 0 0 1 .521.52v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0m35.134 0h6.383a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-6.384a.52.52 0 0 1-.519-.519v-1.5A.52.52 0 0 1 35.652 0Z","data-name":"Path 51"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 3",transform:"translate(.728 4.878)"},l.createElement("path",{fillRule:"evenodd",d:"M.519 0h2.437a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0","data-name":"Path 52"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 13",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 14",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 15",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 16",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 17",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 18",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 19",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 20",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 21",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 22",rx:1,transform:"translate(31)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 23",rx:1,transform:"translate(34.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 24",rx:1,transform:"translate(37.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 25",rx:1,transform:"translate(40.018)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 4",transform:"rotate(180 21.642 2.269)"},l.createElement("path",{fillRule:"evenodd",d:"M.519 0h2.437a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0","data-name":"Path 53"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 26",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 27",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 28",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 29",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 30",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 31",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 32",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 33",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 34",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 35",rx:1,transform:"translate(31.001)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 36",rx:1,transform:"translate(34.007)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 37",rx:1,transform:"translate(37.013)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 38",rx:1,transform:"translate(40.018)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 39",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 40",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 41",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 42",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 43",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 44",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 45",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 46",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 47",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 48",rx:1,transform:"translate(31.001)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 49",rx:1,transform:"translate(34.007)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 50",rx:1,transform:"translate(37.013)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 51",rx:1,transform:"translate(40.018)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 6"},l.createElement("path",{fillRule:"evenodd",d:"M1.247 7.883h3.47a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-3.47A.52.52 0 0 1 .728 9.9V8.403a.52.52 0 0 1 .519-.52","data-name":"Path 54"}),l.createElement("g",{"data-name":"Group 5",transform:"translate(5.801 7.883)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 52",rx:1}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 53",rx:1,transform:"translate(3.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 54",rx:1,transform:"translate(6.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 55",rx:1,transform:"translate(9.018)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 56",rx:1,transform:"translate(12.025)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 57",rx:1,transform:"translate(15.031)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 58",rx:1,transform:"translate(18.037)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 59",rx:1,transform:"translate(21.042)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 60",rx:1,transform:"translate(24.049)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 61",rx:1,transform:"translate(27.055)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 62",rx:1,transform:"translate(30.061)"})),l.createElement("path",{fillRule:"evenodd",d:"M39.482 7.883h3.28a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-3.281a.52.52 0 0 1-.519-.521V8.403a.52.52 0 0 1 .519-.52Z","data-name":"Path 55"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 7",transform:"translate(.728 14.084)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 63",rx:1}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 64",rx:1,transform:"translate(3.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 65",rx:1,transform:"translate(6.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 66",rx:1,transform:"translate(9.018)"}),l.createElement("path",{fillRule:"evenodd",d:"M12.543 0h14.462a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H12.543a.52.52 0 0 1-.519-.52V.519A.52.52 0 0 1 12.543 0m15.97 0h1.874a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-1.874a.52.52 0 0 1-.519-.519v-1.5A.52.52 0 0 1 28.513 0","data-name":"Path 56"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 67",rx:1,transform:"translate(31.376)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 68",rx:1,transform:"translate(34.382)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 69",rx:1,transform:"translate(40.018)"}),l.createElement("path",{d:"M37.199 1.08V.519A.52.52 0 0 1 37.718 0h1.499a.52.52 0 0 1 .519.519v.561Z","data-name":"Path 57"}),l.createElement("path",{d:"M39.737 1.456v.561a.52.52 0 0 1-.519.519h-1.499a.52.52 0 0 1-.519-.519v-.561Z","data-name":"Path 58"})),l.createElement("rect",{width:42.273,height:1.127,fill:"#4a4a4a","data-name":"Rectangle 70",rx:.564,transform:"translate(.915 .556)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 71",opacity:.136,rx:.376,transform:"translate(1.949 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 72",opacity:.136,rx:.376,transform:"translate(5.193 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 73",opacity:.136,rx:.376,transform:"translate(7.688 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 74",opacity:.136,rx:.376,transform:"translate(10.183 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 75",opacity:.136,rx:.376,transform:"translate(12.679 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 76",opacity:.136,rx:.376,transform:"translate(15.797 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 77",opacity:.136,rx:.376,transform:"translate(18.292 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 78",opacity:.136,rx:.376,transform:"translate(20.788 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 79",opacity:.136,rx:.376,transform:"translate(23.283 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 80",opacity:.136,rx:.376,transform:"translate(26.402 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 81",opacity:.136,rx:.376,transform:"translate(28.897 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 82",opacity:.136,rx:.376,transform:"translate(31.393 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 83",opacity:.136,rx:.376,transform:"translate(34.512 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 84",opacity:.136,rx:.376,transform:"translate(37.007 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 85",opacity:.136,rx:.376,transform:"translate(39.502 .744)"})),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M302.996 425.895a3 3 0 0 0-.332.033q-.029-.117-.06-.234a2.594 2.594 0 1 0-2.567-4.455q-.086-.088-.174-.175a2.593 2.593 0 1 0-4.461-2.569q-.116-.031-.231-.06a2.6 2.6 0 1 0-5.128 0q-.115.029-.231.06a2.594 2.594 0 1 0-4.461 2.569 10.384 10.384 0 1 0 17.314 9.992 2.592 2.592 0 1 0 .332-5.161","data-name":"Path 59"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M271.828 407.713h20.779v-10.389h-20.779Z","data-name":"Path 60"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M297.801 403.818a1.3 1.3 0 1 0 0-2.6 1 1 0 0 0-.166.017l-.03-.117a1.3 1.3 0 0 0-.5-2.5 1.3 1.3 0 0 0-.783.269l-.087-.087a1.3 1.3 0 0 0 .263-.776 1.3 1.3 0 0 0-2.493-.509 5.195 5.195 0 1 0 0 10 1.3 1.3 0 0 0 2.493-.509 1.3 1.3 0 0 0-.263-.776l.087-.087a1.3 1.3 0 0 0 .783.269 1.3 1.3 0 0 0 .5-2.5q.016-.058.03-.117a1 1 0 0 0 .166.017","data-name":"Path 61"}),l.createElement("path",{fillRule:"evenodd",d:"M302.997 365.507a1.4 1.4 0 0 1-.255-.026 1.3 1.3 0 0 1-.244-.073 1.4 1.4 0 0 1-.224-.119 2 2 0 0 1-.2-.161 1.5 1.5 0 0 1-.161-.2 1.3 1.3 0 0 1-.218-.722 1.4 1.4 0 0 1 .026-.255 1.5 1.5 0 0 1 .072-.244 1.4 1.4 0 0 1 .12-.223 1.3 1.3 0 0 1 .358-.358 1.4 1.4 0 0 1 .224-.119 1.3 1.3 0 0 1 .244-.073 1.2 1.2 0 0 1 .509 0 1.3 1.3 0 0 1 .468.192 2 2 0 0 1 .2.161 2 2 0 0 1 .161.2 1.3 1.3 0 0 1 .12.223 1.4 1.4 0 0 1 .1.5 1.32 1.32 0 0 1-.379.919 2 2 0 0 1-.2.161 1.4 1.4 0 0 1-.223.119 1.3 1.3 0 0 1-.5.1m10.389-.649a1.33 1.33 0 0 1-.92-.379 2 2 0 0 1-.161-.2 1.3 1.3 0 0 1-.218-.722 1.33 1.33 0 0 1 .379-.919 2 2 0 0 1 .2-.161 1.4 1.4 0 0 1 .224-.119 1.3 1.3 0 0 1 .244-.073 1.2 1.2 0 0 1 .509 0 1.3 1.3 0 0 1 .468.192 2 2 0 0 1 .2.161 1.33 1.33 0 0 1 .379.919 1.5 1.5 0 0 1-.026.255 1.3 1.3 0 0 1-.073.244 2 2 0 0 1-.119.223 2 2 0 0 1-.161.2 2 2 0 0 1-.2.161 1.3 1.3 0 0 1-.722.218","data-name":"Path 62"}),l.createElement("g",{fill:"#61dafb",transform:"translate(466.3 278.56)"},l.createElement("path",{d:"M263.668 117.179c0-5.827-7.3-11.35-18.487-14.775 2.582-11.4 1.434-20.477-3.622-23.382a7.86 7.86 0 0 0-4.016-1v4a4.15 4.15 0 0 1 2.044.466c2.439 1.4 3.5 6.724 2.672 13.574-.2 1.685-.52 3.461-.914 5.272a87 87 0 0 0-11.386-1.954 87.5 87.5 0 0 0-7.459-8.965c5.845-5.433 11.332-8.41 15.062-8.41V78c-4.931 0-11.386 3.514-17.913 9.611-6.527-6.061-12.982-9.539-17.913-9.539v4c3.712 0 9.216 2.959 15.062 8.356a85 85 0 0 0-7.405 8.947 84 84 0 0 0-11.4 1.972 54 54 0 0 1-.932-5.2c-.843-6.85.2-12.175 2.618-13.592a4 4 0 0 1 2.062-.466v-4a8 8 0 0 0-4.052 1c-5.039 2.9-6.168 11.96-3.568 23.328-11.153 3.443-18.415 8.947-18.415 14.757 0 5.828 7.3 11.35 18.487 14.775-2.582 11.4-1.434 20.477 3.622 23.382a7.9 7.9 0 0 0 4.034 1c4.931 0 11.386-3.514 17.913-9.611 6.527 6.061 12.982 9.539 17.913 9.539a8 8 0 0 0 4.052-1c5.039-2.9 6.168-11.96 3.568-23.328 11.111-3.42 18.373-8.943 18.373-14.752m-23.346-11.96a80 80 0 0 1-2.421 7.083 83 83 0 0 0-2.349-4.3 97 97 0 0 0-2.582-4.2c2.547.377 5.004.843 7.353 1.417Zm-8.212 19.1c-1.4 2.421-2.833 4.716-4.321 6.85a93 93 0 0 1-8.1.359c-2.708 0-5.415-.126-8.069-.341q-2.232-3.2-4.339-6.814-2.044-3.523-3.73-7.136a94 94 0 0 1 3.712-7.154c1.4-2.421 2.833-4.716 4.321-6.85a93 93 0 0 1 8.1-.359c2.708 0 5.415.126 8.069.341q2.232 3.2 4.339 6.814 2.044 3.523 3.73 7.136a101 101 0 0 1-3.712 7.15Zm5.792-2.331a77 77 0 0 1 2.474 7.136 80 80 0 0 1-7.387 1.434c.879-1.381 1.757-2.8 2.582-4.25a96 96 0 0 0 2.329-4.324Zm-18.182 19.128a74 74 0 0 1-4.985-5.738c1.614.072 3.263.126 4.931.126 1.685 0 3.353-.036 4.985-.126a70 70 0 0 1-4.931 5.738m-13.34-10.561c-2.546-.377-5-.843-7.352-1.417a80 80 0 0 1 2.421-7.083c.735 1.434 1.506 2.869 2.349 4.3s1.702 2.837 2.582 4.2m13.25-37.314a74 74 0 0 1 4.985 5.738 111 111 0 0 0-4.931-.126c-1.686 0-3.353.036-4.985.126a70 70 0 0 1 4.931-5.738M206.362 103.8a101 101 0 0 0-4.913 8.55 77 77 0 0 1-2.474-7.136 90 90 0 0 1 7.387-1.414m-16.227 22.449c-6.348-2.708-10.454-6.258-10.454-9.073s4.106-6.383 10.454-9.073c1.542-.663 3.228-1.255 4.967-1.811a86 86 0 0 0 4.034 10.92 85 85 0 0 0-3.981 10.866 54 54 0 0 1-5.021-1.826Zm9.647 25.623c-2.439-1.4-3.5-6.724-2.672-13.574.2-1.686.52-3.461.914-5.272a87 87 0 0 0 11.386 1.954 87.5 87.5 0 0 0 7.459 8.965c-5.845 5.433-11.332 8.41-15.062 8.41a4.3 4.3 0 0 1-2.026-.48Zm42.532-13.663c.843 6.85-.2 12.175-2.618 13.592a4 4 0 0 1-2.062.466c-3.712 0-9.216-2.959-15.062-8.356a85 85 0 0 0 7.405-8.947 84 84 0 0 0 11.4-1.972 50 50 0 0 1 .936 5.22Zm6.9-11.96c-1.542.663-3.228 1.255-4.967 1.811a86 86 0 0 0-4.034-10.92 85 85 0 0 0 3.981-10.866 57 57 0 0 1 5.039 1.829c6.348 2.708 10.454 6.258 10.454 9.073-.017 2.818-4.123 6.386-10.471 9.076Z","data-name":"Path 330"}),l.createElement("path",{d:"M201.718 78.072","data-name":"Path 331"}),l.createElement("circle",{cx:8.194,cy:8.194,r:8.194,"data-name":"Ellipse 112",transform:"translate(211.472 108.984)"}),l.createElement("path",{d:"M237.525 78.018","data-name":"Path 332"})))))}},3844:(e,a,t)=>{t.d(a,{A:()=>B});var r,l,n,c,h,d,m,i,s,f,o,g,E,p,x,v,R,w,u,y,M,P,b,Z,j,A,q,N,V,H,k,G,C,S,O,z,F=t(6540);function T(){return T=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...B}=e;return F.createElement("svg",T({xmlns:"http://www.w3.org/2000/svg",width:1129,height:663,viewBox:"0 0 1129 663","aria-labelledby":t},B),void 0===a?F.createElement("title",{id:t},"Focus on What Matters"):a?F.createElement("title",{id:t},a):null,r||(r=F.createElement("circle",{cx:321,cy:321,r:321,fill:"#f2f2f2"})),l||(l=F.createElement("ellipse",{cx:559,cy:635.5,fill:"#3f3d56",rx:514,ry:27.5})),n||(n=F.createElement("ellipse",{cx:558,cy:627,opacity:.2,rx:460,ry:22})),c||(c=F.createElement("path",{fill:"#3f3d56",d:"M131 152.5h840v50H131z"})),h||(h=F.createElement("path",{fill:"#3f3d56",d:"M131 608.83a21.67 21.67 0 0 0 21.67 21.67h796.66A21.67 21.67 0 0 0 971 608.83V177.5H131ZM949.33 117.5H152.67A21.67 21.67 0 0 0 131 139.17v38.33h840v-38.33a21.67 21.67 0 0 0-21.67-21.67"})),d||(d=F.createElement("path",{d:"M949.33 117.5H152.67A21.67 21.67 0 0 0 131 139.17v38.33h840v-38.33a21.67 21.67 0 0 0-21.67-21.67",opacity:.2})),m||(m=F.createElement("circle",{cx:181,cy:147.5,r:13,fill:"#3f3d56"})),i||(i=F.createElement("circle",{cx:217,cy:147.5,r:13,fill:"#3f3d56"})),s||(s=F.createElement("circle",{cx:253,cy:147.5,r:13,fill:"#3f3d56"})),f||(f=F.createElement("rect",{width:337,height:386,x:168,y:213.5,fill:"#606060",rx:5.335})),o||(o=F.createElement("rect",{width:284,height:22,x:603,y:272.5,fill:"#2e8555",rx:5.476})),g||(g=F.createElement("rect",{width:416,height:15,x:537,y:352.5,fill:"#2e8555",rx:5.476})),E||(E=F.createElement("rect",{width:416,height:15,x:537,y:396.5,fill:"#2e8555",rx:5.476})),p||(p=F.createElement("rect",{width:416,height:15,x:537,y:440.5,fill:"#2e8555",rx:5.476})),x||(x=F.createElement("rect",{width:416,height:15,x:537,y:484.5,fill:"#2e8555",rx:5.476})),v||(v=F.createElement("rect",{width:88,height:26,x:865,y:552.5,fill:"#3ecc5f",rx:7.028})),R||(R=F.createElement("path",{fill:"#3f3d56",d:"M1053.103 506.116a30.1 30.1 0 0 0 3.983-15.266c0-13.797-8.544-24.98-19.083-24.98s-19.082 11.183-19.082 24.98a30.1 30.1 0 0 0 3.983 15.266 31.25 31.25 0 0 0 0 30.532 31.25 31.25 0 0 0 0 30.532 31.25 31.25 0 0 0 0 30.532 30.1 30.1 0 0 0-3.983 15.266c0 13.797 8.543 24.981 19.082 24.981s19.083-11.184 19.083-24.98a30.1 30.1 0 0 0-3.983-15.267 31.25 31.25 0 0 0 0-30.532 31.25 31.25 0 0 0 0-30.532 31.25 31.25 0 0 0 0-30.532"})),w||(w=F.createElement("ellipse",{cx:1038.003,cy:460.318,fill:"#3f3d56",rx:19.083,ry:24.981})),u||(u=F.createElement("ellipse",{cx:1038.003,cy:429.786,fill:"#3f3d56",rx:19.083,ry:24.981})),y||(y=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M1109.439 220.845a92 92 0 0 0 7.106-10.461l-50.14-8.235 54.228.403a91.57 91.57 0 0 0 1.746-72.426l-72.755 37.742 67.097-49.321A91.413 91.413 0 1 0 965.75 220.845a91.5 91.5 0 0 0-10.425 16.67l65.087 33.814-69.4-23.292a91.46 91.46 0 0 0 14.738 85.837 91.406 91.406 0 1 0 143.689 0 91.42 91.42 0 0 0 0-113.03"})),M||(M=F.createElement("path",{d:"M946.189 277.36a91 91 0 0 0 19.56 56.514 91.406 91.406 0 1 0 143.69 0c12.25-15.553-163.25-66.774-163.25-56.515",opacity:.1})),P||(P=F.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M330.12 342.936h111.474v45.12H330.12Z"})),b||(b=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M229.263 490.241a26.51 26.51 0 0 1-22.963-13.27 26.51 26.51 0 0 0 22.963 39.812h26.541V490.24Z"})),Z||(Z=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m348.672 350.07 92.922-5.807v-13.27a26.54 26.54 0 0 0-26.541-26.542H295.616l-3.318-5.746a3.83 3.83 0 0 0-6.635 0l-3.318 5.746-3.317-5.746a3.83 3.83 0 0 0-6.636 0l-3.317 5.746-3.318-5.746a3.83 3.83 0 0 0-6.635 0l-3.318 5.746c-.03 0-.056.004-.086.004l-5.497-5.495a3.83 3.83 0 0 0-6.407 1.717l-1.817 6.773-6.89-1.847a3.83 3.83 0 0 0-4.691 4.693l1.844 6.891-6.77 1.814a3.832 3.832 0 0 0-1.72 6.41l5.497 5.497q-.002.041-.004.085l-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318a26.54 26.54 0 0 0 26.541 26.542h159.249a26.54 26.54 0 0 0 26.541-26.542V384.075l-92.922-5.807a14.126 14.126 0 0 1 0-28.197"})),j||(j=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M388.511 516.783h39.812V463.7h-39.812Z"})),A||(A=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M454.865 483.606a7 7 0 0 0-.848.085q-.073-.3-.154-.599a6.627 6.627 0 1 0-6.557-11.382q-.22-.225-.445-.446a6.624 6.624 0 1 0-11.397-6.564c-.196-.055-.394-.102-.59-.152a6.64 6.64 0 1 0-13.101 0c-.197.05-.394.097-.59.152a6.628 6.628 0 1 0-11.398 6.564 26.528 26.528 0 1 0 44.232 25.528 6.621 6.621 0 1 0 .848-13.186"})),q||(q=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M401.782 437.158h39.812v-26.541h-39.812Z"})),N||(N=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M454.865 427.205a3.318 3.318 0 0 0 0-6.635 3 3 0 0 0-.424.042c-.026-.1-.049-.199-.077-.298a3.319 3.319 0 0 0-1.278-6.38 3.28 3.28 0 0 0-2 .688q-.11-.113-.224-.223a3.3 3.3 0 0 0 .672-1.983 3.318 3.318 0 0 0-6.37-1.299 13.27 13.27 0 1 0 0 25.541 3.318 3.318 0 0 0 6.37-1.3 3.3 3.3 0 0 0-.672-1.982q.114-.11.223-.223a3.28 3.28 0 0 0 2.001.688 3.318 3.318 0 0 0 1.278-6.38c.028-.098.05-.199.077-.298a3 3 0 0 0 .424.042"})),V||(V=F.createElement("path",{fillRule:"evenodd",d:"M282.345 347.581a3.32 3.32 0 0 1-3.317-3.318 9.953 9.953 0 1 0-19.906 0 3.318 3.318 0 1 1-6.636 0 16.588 16.588 0 1 1 33.177 0 3.32 3.32 0 0 1-3.318 3.318"})),H||(H=F.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M335.428 516.783h79.625a26.54 26.54 0 0 0 26.541-26.542v-92.895H361.97a26.54 26.54 0 0 0-26.542 26.542Z"})),k||(k=F.createElement("path",{fillRule:"evenodd",d:"M421.714 438.485h-66.406a1.327 1.327 0 0 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.542h-66.406a1.327 1.327 0 1 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.541h-66.406a1.327 1.327 0 1 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0-66.106h-66.406a1.327 1.327 0 0 1 0-2.655h66.406a1.327 1.327 0 0 1 0 2.655m0 26.294h-66.406a1.327 1.327 0 0 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.542h-66.406a1.327 1.327 0 0 1 0-2.655h66.406a1.327 1.327 0 0 1 0 2.655m19.88-122.607c-.016 0-.03-.008-.045-.007-4.1.14-6.04 4.241-7.753 7.86-1.786 3.783-3.168 6.242-5.432 6.167-2.506-.09-3.94-2.922-5.458-5.918-1.744-3.443-3.734-7.347-7.913-7.201-4.042.138-5.99 3.708-7.706 6.857-1.828 3.355-3.071 5.394-5.47 5.3-2.557-.093-3.916-2.395-5.488-5.06-1.753-2.967-3.78-6.304-7.878-6.19-3.973.137-5.925 3.166-7.648 5.84-1.822 2.826-3.098 4.549-5.527 4.447-2.618-.093-3.97-2.004-5.535-4.216-1.757-2.486-3.737-5.3-7.823-5.163-3.886.133-5.838 2.615-7.56 4.802-1.634 2.075-2.91 3.718-5.611 3.615a1.328 1.328 0 1 0-.096 2.654c4.004.134 6.032-2.389 7.793-4.628 1.562-1.985 2.91-3.698 5.564-3.789 2.556-.108 3.754 1.48 5.567 4.041 1.721 2.434 3.675 5.195 7.606 5.337 4.118.138 6.099-2.94 7.853-5.663 1.569-2.434 2.923-4.535 5.508-4.624 2.38-.088 3.674 1.792 5.5 4.885 1.722 2.916 3.671 6.22 7.68 6.365 4.147.143 6.15-3.477 7.895-6.682 1.511-2.77 2.938-5.388 5.466-5.475 2.38-.056 3.62 2.116 5.456 5.746 1.714 3.388 3.658 7.226 7.73 7.373l.224.004c4.066 0 5.996-4.08 7.704-7.689 1.511-3.198 2.942-6.21 5.397-6.334Z"})),G||(G=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.887 516.783h53.083V463.7h-53.083Z"})),C||(C=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M388.511 483.606a7 7 0 0 0-.848.085c-.05-.2-.098-.4-.154-.599a6.627 6.627 0 1 0-6.557-11.382q-.22-.225-.444-.446a6.624 6.624 0 1 0-11.397-6.564c-.197-.055-.394-.102-.59-.152a6.64 6.64 0 1 0-13.102 0c-.196.05-.394.097-.59.152a6.628 6.628 0 1 0-11.397 6.564 26.528 26.528 0 1 0 44.231 25.528 6.621 6.621 0 1 0 .848-13.186"})),S||(S=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.887 437.158h53.083v-26.541h-53.083Z"})),O||(O=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M375.24 427.205a3.318 3.318 0 1 0 0-6.635 3 3 0 0 0-.423.042q-.038-.15-.077-.298a3.319 3.319 0 0 0-1.278-6.38 3.28 3.28 0 0 0-2.001.688q-.11-.113-.223-.223a3.3 3.3 0 0 0 .671-1.983 3.318 3.318 0 0 0-6.37-1.299 13.27 13.27 0 1 0 0 25.541 3.318 3.318 0 0 0 6.37-1.3 3.3 3.3 0 0 0-.671-1.982q.113-.11.223-.223a3.28 3.28 0 0 0 2.001.688 3.318 3.318 0 0 0 1.278-6.38c.028-.098.05-.199.077-.298a3 3 0 0 0 .423.042"})),z||(z=F.createElement("path",{fillRule:"evenodd",d:"M388.511 329.334a3.6 3.6 0 0 1-.65-.067 3.3 3.3 0 0 1-.624-.185 3.5 3.5 0 0 1-.572-.306 5 5 0 0 1-.504-.411 4 4 0 0 1-.41-.504 3.28 3.28 0 0 1-.558-1.845 3.6 3.6 0 0 1 .067-.65 4 4 0 0 1 .184-.624 3.5 3.5 0 0 1 .307-.57 3.2 3.2 0 0 1 .914-.916 3.5 3.5 0 0 1 .572-.305 3.3 3.3 0 0 1 .624-.186 3.1 3.1 0 0 1 1.3 0 3.2 3.2 0 0 1 1.195.49 5 5 0 0 1 .504.412 5 5 0 0 1 .411.504 3.4 3.4 0 0 1 .306.571 3.5 3.5 0 0 1 .252 1.274 3.36 3.36 0 0 1-.969 2.349 5 5 0 0 1-.504.411 3.3 3.3 0 0 1-1.845.558m26.542-1.66a3.4 3.4 0 0 1-2.35-.968 5 5 0 0 1-.41-.504 3.28 3.28 0 0 1-.558-1.845 3.39 3.39 0 0 1 .967-2.349 5 5 0 0 1 .505-.411 3.5 3.5 0 0 1 .572-.305 3.3 3.3 0 0 1 .623-.186 3.1 3.1 0 0 1 1.3 0 3.2 3.2 0 0 1 1.195.49 5 5 0 0 1 .504.412 3.4 3.4 0 0 1 .97 2.35 4 4 0 0 1-.067.65 3.4 3.4 0 0 1-.186.623 5 5 0 0 1-.305.57 5 5 0 0 1-.412.505 5 5 0 0 1-.504.412 3.3 3.3 0 0 1-1.844.557"})))}},4706:(e,a,t)=>{t.r(a),t.d(a,{default:()=>M});var r=t(4164),l=t(8774),n=t(4586),c=t(9201),h=t(1107);const d={features:"features_t9lD",featureSvg:"featureSvg_GfXr"};var m=t(856);function i(){for(var e=arguments.length,a=new Array(e),t=0;t(0,s.jsx)(o,{...e},a)))})})})}var E=t(6932),p=t(6540),x=t(7859);const v=(0,t(6990).F)("inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50",{variants:{variant:{default:"bg-primary text-primary-foreground hover:bg-primary/90",destructive:"bg-destructive text-destructive-foreground hover:bg-destructive/90",outline:"border border-input bg-background hover:bg-accent hover:text-accent-foreground",secondary:"bg-secondary text-secondary-foreground hover:bg-secondary/80",ghost:"hover:bg-accent hover:text-accent-foreground",link:"text-primary underline-offset-4 hover:underline"},size:{default:"h-10 px-4 py-2",sm:"h-9 rounded-md px-3",lg:"h-11 rounded-md px-8",icon:"h-10 w-10"}},defaultVariants:{variant:"default",size:"default"}}),R=p.forwardRef(((e,a)=>{let{className:t,variant:r,size:l,asChild:n=!1,...c}=e;const h=n?x.DX:"button";return(0,s.jsx)(h,{className:i(v({variant:r,size:l,className:t})),ref:a,...c})}));function w(e){let{demo:a=!1,onAcceptCallback:t=()=>{},onDeclineCallback:r=()=>{}}=e;const[l,n]=(0,p.useState)(!1),[c,h]=(0,p.useState)(!1);return(0,p.useEffect)((()=>{try{n(!0),document.cookie.includes("cookieConsent=true")&&(a||(n(!1),setTimeout((()=>{h(!0)}),700)))}catch(e){}}),[]),(0,s.jsx)("div",{className:i("fixed z-[200] bottom-0 left-0 right-0 sm:left-4 sm:bottom-4 w-full sm:max-w-md transition-transform duration-700",l?"transition-[opacity,transform] translate-y-0 opacity-100":"transition-[opacity,transform] translate-y-8 opacity-0",c&&"hidden"),children:(0,s.jsx)("div",{className:"bg-secondary rounded-md m-2",children:(0,s.jsxs)("div",{className:"grid gap-2",children:[(0,s.jsxs)("div",{className:"border-b border-border h-14 flex items-center justify-between p-4",children:[(0,s.jsx)("h1",{className:"text-lg font-medium",children:"We use cookies and TOS"}),(0,s.jsx)(E.A,{className:"h-[1.2rem] w-[1.2rem]"})]}),(0,s.jsx)("div",{className:"p-4",children:(0,s.jsxs)("p",{className:"text-sm font-normal",children:["We use cookies to ensure you get the best experience on our website. For more information on how we use cookies, please see our cookie policy.",(0,s.jsx)("br",{}),(0,s.jsx)("br",{}),(0,s.jsxs)("span",{className:"text-xs",children:['By clicking "',(0,s.jsx)("span",{className:"font-medium opacity-80",children:"Accept"}),'", you agree to our use of cookies and the TOS.']}),(0,s.jsx)("br",{}),(0,s.jsx)("a",{href:"https://raw.githubusercontent.com/open-wa/wa-automate-nodejs/master/tos.md",className:"text-xs underline",children:"Learn more."})]})}),(0,s.jsxs)("div",{className:"flex gap-2 p-4 py-5 border-t border-border bg-background/20",children:[(0,s.jsx)(R,{onClick:()=>{n(!1),document.cookie="cookieConsent=true; expires=Fri, 31 Dec 9999 23:59:59 GMT",setTimeout((()=>{h(!0)}),700),t()},className:"w-full",children:"Accept"}),(0,s.jsx)(R,{onClick:()=>{n(!1),setTimeout((()=>{h(!0)}),700),r()},className:"w-full",variant:"secondary",children:"Double Accept"})]})]})})})}R.displayName="Button";const u={heroBanner:"heroBanner_qdFl",buttons:"buttons_AeoN"};function y(){const{siteConfig:e}=(0,n.A)();return(0,s.jsx)("header",{className:(0,r.A)("hero hero--primary",u.heroBanner),children:(0,s.jsxs)("div",{className:"container",children:[(0,s.jsx)(h.A,{as:"h1",className:"hero__title",children:e.title}),(0,s.jsx)("p",{className:"hero__subtitle",children:e.tagline}),(0,s.jsx)("div",{className:u.buttons,children:(0,s.jsx)(l.A,{className:"button button--secondary button--lg",to:"/docs/intro",children:"Docusaurus Tutorial - 5min \u23f1\ufe0f"})})]})})}function M(){const{siteConfig:e}=(0,n.A)();return(0,s.jsxs)(c.A,{title:`Hello from ${e.title}`,description:"Description will go into a meta tag in ",children:[(0,s.jsx)(w,{}),(0,s.jsx)(y,{}),(0,s.jsx)("main",{children:(0,s.jsx)(g,{})})]})}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4583],{870:(e,a,t)=>{t.d(a,{A:()=>c});var r,l=t(6540);function n(){return n=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...c}=e;return l.createElement("svg",n({xmlns:"http://www.w3.org/2000/svg",width:1088,height:687.962,viewBox:"0 0 1088 687.962","aria-labelledby":t},c),void 0===a?l.createElement("title",{id:t},"Easy to Use"):a?l.createElement("title",{id:t},a):null,r||(r=l.createElement("g",{"data-name":"Group 12"},l.createElement("g",{"data-name":"Group 11"},l.createElement("path",{fill:"#3f3d56",d:"M961.81 454.442c-5.27 45.15-16.22 81.4-31.25 110.31-20 38.52-54.21 54.04-84.77 70.28a193 193 0 0 1-27.46 11.94c-55.61 19.3-117.85 14.18-166.74 3.99a657 657 0 0 0-104.09-13.16q-14.97-.675-29.97-.67c-15.42.02-293.07 5.29-360.67-131.57-16.69-33.76-28.13-75-32.24-125.27-11.63-142.12 52.29-235.46 134.74-296.47 155.97-115.41 369.76-110.57 523.43 7.88 102.36 78.9 198.2 198.31 179.02 362.74","data-name":"Path 83"}),l.createElement("path",{fill:"#f2f2f2",d:"M930.56 564.752c-20 38.52-47.21 64.04-77.77 80.28a193 193 0 0 1-27.46 11.94c-55.61 19.3-117.85 14.18-166.74 3.99a657 657 0 0 0-104.09-13.16q-14.97-.675-29.97-.67-23.13.03-46.25 1.72c-100.17 7.36-253.82-6.43-321.42-143.29L326 177.962l62.95 161.619 20.09 51.59 55.37-75.98L493 275.962l130.2 149.27 36.8-81.27 254.78 207.919 14.21 11.59Z","data-name":"Path 84"}),l.createElement("path",{d:"m302 282.962 26-57 36 83-31-60Z","data-name":"Path 85",opacity:.1}),l.createElement("path",{d:"M554.5 647.802q-14.97-.675-29.97-.67l-115.49-255.96Z","data-name":"Path 86",opacity:.1}),l.createElement("path",{d:"M464.411 315.191 493 292.962l130 150-132-128Z","data-name":"Path 87",opacity:.1}),l.createElement("path",{d:"M852.79 645.032a193 193 0 0 1-27.46 11.94L623.2 425.232Z","data-name":"Path 88",opacity:.1}),l.createElement("circle",{cx:3,cy:3,r:3,fill:"#f2f2f2","data-name":"Ellipse 11",transform:"translate(479 98.962)"}),l.createElement("circle",{cx:3,cy:3,r:3,fill:"#f2f2f2","data-name":"Ellipse 12",transform:"translate(396 201.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 13",transform:"translate(600 220.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 14",transform:"translate(180 265.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 15",transform:"translate(612 96.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 16",transform:"translate(736 192.962)"}),l.createElement("circle",{cx:2,cy:2,r:2,fill:"#f2f2f2","data-name":"Ellipse 17",transform:"translate(858 344.962)"}),l.createElement("path",{fill:"#f2f2f2",d:"M306 121.222h-2.76v-2.76h-1.48v2.76H299v1.478h2.76v2.759h1.48V122.7H306Z","data-name":"Path 89"}),l.createElement("path",{fill:"#f2f2f2",d:"M848 424.222h-2.76v-2.76h-1.48v2.76H841v1.478h2.76v2.759h1.48V425.7H848Z","data-name":"Path 90"}),l.createElement("path",{fill:"#3f3d56",d:"M1088 613.962c0 16.569-243.557 74-544 74s-544-57.431-544-74 243.557 14 544 14 544-30.568 544-14","data-name":"Path 91"}),l.createElement("path",{d:"M1088 613.962c0 16.569-243.557 74-544 74s-544-57.431-544-74 243.557 14 544 14 544-30.568 544-14","data-name":"Path 92",opacity:.1}),l.createElement("ellipse",{cx:544,cy:30,fill:"#3f3d56","data-name":"Ellipse 18",rx:544,ry:30,transform:"translate(0 583.962)"}),l.createElement("path",{fill:"#ff6584",d:"M568 571.962c0 33.137-14.775 24-33 24s-33 9.137-33-24 33-96 33-96 33 62.863 33 96","data-name":"Path 93"}),l.createElement("path",{d:"M550 584.641c0 15.062-6.716 10.909-15 10.909s-15 4.153-15-10.909 15-43.636 15-43.636 15 28.576 15 43.636","data-name":"Path 94",opacity:.1}),l.createElement("rect",{width:92,height:18,fill:"#2f2e41","data-name":"Rectangle 97",rx:9,transform:"translate(489 604.962)"}),l.createElement("rect",{width:92,height:18,fill:"#2f2e41","data-name":"Rectangle 98",rx:9,transform:"translate(489 586.962)"}),l.createElement("path",{fill:"#3f3d56",d:"M137 490.528c0 55.343 34.719 100.126 77.626 100.126","data-name":"Path 95"}),l.createElement("path",{fill:"#6c63ff",d:"M214.626 590.654c0-55.965 38.745-101.251 86.626-101.251","data-name":"Path 96"}),l.createElement("path",{fill:"#6c63ff",d:"M165.125 495.545c0 52.57 22.14 95.109 49.5 95.109","data-name":"Path 97"}),l.createElement("path",{fill:"#3f3d56",d:"M214.626 590.654c0-71.511 44.783-129.377 100.126-129.377","data-name":"Path 98"}),l.createElement("path",{fill:"#a8a8a8",d:"M198.3 591.36s11.009-.339 14.326-2.7 16.934-5.183 17.757-1.395 16.544 18.844 4.115 18.945-28.879-1.936-32.19-3.953-4.008-10.897-4.008-10.897","data-name":"Path 99"}),l.createElement("path",{d:"M234.716 604.89c-12.429.1-28.879-1.936-32.19-3.953-2.522-1.536-3.527-7.048-3.863-9.591l-.368.014s.7 8.879 4.009 10.9 19.761 4.053 32.19 3.953c3.588-.029 4.827-1.305 4.759-3.2-.498 1.142-1.867 1.855-4.537 1.877","data-name":"Path 100",opacity:.2}),l.createElement("path",{fill:"#3f3d56",d:"M721.429 527.062c0 38.029 23.857 68.8 53.341 68.8","data-name":"Path 101"}),l.createElement("path",{fill:"#6c63ff",d:"M774.769 595.863c0-38.456 26.623-69.575 59.525-69.575","data-name":"Path 102"}),l.createElement("path",{fill:"#6c63ff",d:"M740.755 530.509c0 36.124 15.213 65.354 34.014 65.354","data-name":"Path 103"}),l.createElement("path",{fill:"#3f3d56",d:"M774.769 595.863c0-49.139 30.773-88.9 68.8-88.9","data-name":"Path 104"}),l.createElement("path",{fill:"#a8a8a8",d:"M763.548 596.348s7.565-.233 9.844-1.856 11.636-3.562 12.2-.958 11.368 12.949 2.828 13.018-19.844-1.33-22.119-2.716-2.753-7.488-2.753-7.488","data-name":"Path 105"}),l.createElement("path",{d:"M788.574 605.645c-8.54.069-19.844-1.33-22.119-2.716-1.733-1.056-2.423-4.843-2.654-6.59l-.253.01s.479 6.1 2.755 7.487 13.579 2.785 22.119 2.716c2.465-.02 3.317-.9 3.27-2.2-.343.788-1.283 1.278-3.118 1.293","data-name":"Path 106",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M893.813 618.699s11.36-1.729 14.5-4.591 16.89-7.488 18.217-3.667 19.494 17.447 6.633 19.107-30.153 1.609-33.835-.065-5.515-10.784-5.515-10.784","data-name":"Path 107"}),l.createElement("path",{d:"M933.228 628.154c-12.86 1.659-30.153 1.609-33.835-.065-2.8-1.275-4.535-6.858-5.2-9.45l-.379.061s1.833 9.109 5.516 10.783 20.975 1.725 33.835.065c3.712-.479 4.836-1.956 4.529-3.906-.375 1.246-1.703 2.156-4.466 2.512","data-name":"Path 108",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M614.26 617.881s9.587-1.459 12.237-3.875 14.255-6.32 15.374-3.095 16.452 14.725 5.6 16.125-25.448 1.358-28.555-.055-4.656-9.1-4.656-9.1","data-name":"Path 109"}),l.createElement("path",{d:"M647.524 625.856c-10.853 1.4-25.448 1.358-28.555-.055-2.367-1.076-3.827-5.788-4.39-7.976l-.32.051s1.547 7.687 4.655 9.1 17.7 1.456 28.555.055c3.133-.4 4.081-1.651 3.822-3.3-.314 1.057-1.435 1.825-3.767 2.125","data-name":"Path 110",opacity:.2}),l.createElement("path",{fill:"#a8a8a8",d:"M122.389 613.09s7.463-1.136 9.527-3.016 11.1-4.92 11.969-2.409 12.808 11.463 4.358 12.553-19.811 1.057-22.23-.043-3.624-7.085-3.624-7.085","data-name":"Path 111"}),l.createElement("path",{d:"M148.285 619.302c-8.449 1.09-19.811 1.057-22.23-.043-1.842-.838-2.979-4.506-3.417-6.209l-.249.04s1.2 5.984 3.624 7.085 13.781 1.133 22.23.043c2.439-.315 3.177-1.285 2.976-2.566-.246.818-1.119 1.416-2.934 1.65","data-name":"Path 112",opacity:.2}),l.createElement("path",{d:"M383.7 601.318c0 30.22-42.124 20.873-93.7 20.873s-93.074 9.347-93.074-20.873 42.118-36.793 93.694-36.793 93.08 6.573 93.08 36.793","data-name":"Path 113",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M383.7 593.881c0 30.22-42.124 20.873-93.7 20.873s-93.074 9.347-93.074-20.873 42.114-36.8 93.69-36.8 93.084 6.576 93.084 36.8","data-name":"Path 114"})),l.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M360.175 475.732h91.791v37.153h-91.791Z","data-name":"Path 40"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M277.126 597.026a21.83 21.83 0 0 1-18.908-10.927 21.829 21.829 0 0 0 18.908 32.782h21.855v-21.855Z","data-name":"Path 41"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m375.451 481.607 76.514-4.782v-10.928a21.854 21.854 0 0 0-21.855-21.855h-98.347l-2.732-4.735a3.154 3.154 0 0 0-5.464 0l-2.732 4.732-2.732-4.732a3.154 3.154 0 0 0-5.464 0l-2.732 4.732-2.731-4.732a3.154 3.154 0 0 0-5.464 0l-2.732 4.735h-.071l-4.526-4.525a3.153 3.153 0 0 0-5.276 1.414l-1.5 5.577-5.674-1.521a3.154 3.154 0 0 0-3.863 3.864l1.52 5.679-5.575 1.494a3.155 3.155 0 0 0-1.416 5.278l4.526 4.526v.07l-4.735 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.727a3.154 3.154 0 0 0 0 5.464l4.735 2.736-4.735 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.732a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.731a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.735a3.154 3.154 0 0 0 0 5.464l4.732 2.732-4.732 2.728a3.154 3.154 0 0 0 0 5.464l4.732 2.732a21.854 21.854 0 0 0 21.858 21.855h131.13a21.854 21.854 0 0 0 21.855-21.855v-87.42l-76.514-4.782a11.632 11.632 0 0 1 0-23.219","data-name":"Path 42"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M408.255 618.882h32.782v-43.71h-32.782Z","data-name":"Path 43"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M462.893 591.563a5 5 0 0 0-.7.07c-.042-.164-.081-.329-.127-.493a5.457 5.457 0 1 0-5.4-9.372q-.181-.185-.366-.367a5.454 5.454 0 1 0-9.384-5.4c-.162-.046-.325-.084-.486-.126a5.467 5.467 0 1 0-10.788 0c-.162.042-.325.08-.486.126a5.457 5.457 0 1 0-9.384 5.4 21.843 21.843 0 1 0 36.421 21.02 5.452 5.452 0 1 0 .7-10.858","data-name":"Path 44"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M419.183 553.317h32.782v-21.855h-32.782Z","data-name":"Path 45"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M462.893 545.121a2.732 2.732 0 1 0 0-5.464 3 3 0 0 0-.349.035c-.022-.082-.04-.164-.063-.246a2.733 2.733 0 0 0-1.052-5.253 2.7 2.7 0 0 0-1.648.566q-.09-.093-.184-.184a2.7 2.7 0 0 0 .553-1.633 2.732 2.732 0 0 0-5.245-1.07 10.928 10.928 0 1 0 0 21.031 2.732 2.732 0 0 0 5.245-1.07 2.7 2.7 0 0 0-.553-1.633q.093-.09.184-.184a2.7 2.7 0 0 0 1.648.566 2.732 2.732 0 0 0 1.052-5.253q.033-.122.063-.246a3 3 0 0 0 .349.035","data-name":"Path 46"}),l.createElement("path",{fillRule:"evenodd",d:"M320.836 479.556a2.73 2.73 0 0 1-2.732-2.732 8.2 8.2 0 0 0-16.391 0 2.732 2.732 0 0 1-5.464 0 13.66 13.66 0 0 1 27.319 0 2.73 2.73 0 0 1-2.732 2.732","data-name":"Path 47"}),l.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M364.546 618.881h65.565a21.854 21.854 0 0 0 21.855-21.855v-76.492h-65.565a21.854 21.854 0 0 0-21.855 21.855Z","data-name":"Path 48"}),l.createElement("path",{fillRule:"evenodd",d:"M435.596 554.41h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0-54.434h-54.681a1.093 1.093 0 1 1 0-2.185h54.681a1.093 1.093 0 0 1 0 2.185m0 21.652h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m0 21.855h-54.681a1.093 1.093 0 1 1 0-2.186h54.681a1.093 1.093 0 0 1 0 2.186m16.369-100.959c-.013 0-.024-.007-.037-.005-3.377.115-4.974 3.492-6.384 6.472-1.471 3.114-2.608 5.139-4.473 5.078-2.064-.074-3.244-2.406-4.494-4.874-1.436-2.835-3.075-6.049-6.516-5.929-3.329.114-4.932 3.053-6.346 5.646-1.5 2.762-2.529 4.442-4.5 4.364-2.106-.076-3.225-1.972-4.52-4.167-1.444-2.443-3.112-5.191-6.487-5.1-3.272.113-4.879 2.606-6.3 4.808-1.5 2.328-2.552 3.746-4.551 3.662-2.156-.076-3.27-1.65-4.558-3.472-1.447-2.047-3.077-4.363-6.442-4.251-3.2.109-4.807 2.153-6.224 3.954-1.346 1.709-2.4 3.062-4.621 2.977a1.094 1.094 0 0 0-.079 2.186c3.3.11 4.967-1.967 6.417-3.81 1.286-1.635 2.4-3.045 4.582-3.12 2.1-.09 3.091 1.218 4.584 3.327 1.417 2 3.026 4.277 6.263 4.394 3.391.114 5.022-2.42 6.467-4.663 1.292-2 2.406-3.734 4.535-3.807 1.959-.073 3.026 1.475 4.529 4.022 1.417 2.4 3.023 5.121 6.324 5.241 3.415.118 5.064-2.863 6.5-5.5 1.245-2.282 2.419-4.437 4.5-4.509 1.959-.046 2.981 1.743 4.492 4.732 1.412 2.79 3.013 5.95 6.365 6.071h.185c3.348 0 4.937-3.36 6.343-6.331 1.245-2.634 2.423-5.114 4.444-5.216Z","data-name":"Path 49"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M342.691 618.882h43.71v-43.71h-43.71Z","data-name":"Path 50"}),l.createElement("g",{"data-name":"Group 8",transform:"rotate(-14.98 2188.845 -1120.376)"},l.createElement("rect",{width:92.361,height:36.462,fill:"#d8d8d8","data-name":"Rectangle 3",rx:2}),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 2",transform:"translate(1.531 23.03)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 4",rx:1,transform:"translate(16.797)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 5",rx:1,transform:"translate(23.12)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 6",rx:1,transform:"translate(29.444)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 7",rx:1,transform:"translate(35.768)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 8",rx:1,transform:"translate(42.091)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 9",rx:1,transform:"translate(48.415)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 10",rx:1,transform:"translate(54.739)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 11",rx:1,transform:"translate(61.063)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 12",rx:1,transform:"translate(67.386)"}),l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h13.425a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H1.093A1.093 1.093 0 0 1 0 4.243v-3.15A1.093 1.093 0 0 1 1.093 0M75 0h13.426a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H75a1.093 1.093 0 0 1-1.093-1.093v-3.15A1.093 1.093 0 0 1 75 0","data-name":"Path 51"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 3",transform:"translate(1.531 10.261)"},l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h5.125A1.093 1.093 0 0 1 7.31 1.093v3.149a1.093 1.093 0 0 1-1.092 1.093H1.093A1.093 1.093 0 0 1 0 4.242V1.093A1.093 1.093 0 0 1 1.093 0","data-name":"Path 52"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 13",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 14",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 15",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 16",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 17",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 18",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 19",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 20",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 21",rx:1,transform:"translate(58.888)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 22",rx:1,transform:"translate(65.212)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 23",rx:1,transform:"translate(71.536)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 24",rx:1,transform:"translate(77.859)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 25",rx:1,transform:"translate(84.183)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 4",transform:"rotate(180 45.525 4.773)"},l.createElement("path",{fillRule:"evenodd",d:"M1.093 0h5.126a1.093 1.093 0 0 1 1.093 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093H1.093A1.093 1.093 0 0 1 0 4.243v-3.15A1.093 1.093 0 0 1 1.093 0","data-name":"Path 53"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 26",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 27",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 28",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 29",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 30",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 31",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 32",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 33",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 34",rx:1,transform:"translate(58.889)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 35",rx:1,transform:"translate(65.213)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 36",rx:1,transform:"translate(71.537)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 37",rx:1,transform:"translate(77.86)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 38",rx:1,transform:"translate(84.183)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 39",rx:1,transform:"translate(8.299)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 40",rx:1,transform:"translate(14.623)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 41",rx:1,transform:"translate(20.947)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 42",rx:1,transform:"translate(27.271)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 43",rx:1,transform:"translate(33.594)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 44",rx:1,transform:"translate(39.918)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 45",rx:1,transform:"translate(46.242)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 46",rx:1,transform:"translate(52.565)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 47",rx:1,transform:"translate(58.889)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 48",rx:1,transform:"translate(65.213)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 49",rx:1,transform:"translate(71.537)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 50",rx:1,transform:"translate(77.86)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 51",rx:1,transform:"translate(84.183)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 6"},l.createElement("path",{fillRule:"evenodd",d:"M2.624 16.584h7.3a1.093 1.093 0 0 1 1.092 1.093v3.15a1.093 1.093 0 0 1-1.093 1.093h-7.3a1.093 1.093 0 0 1-1.092-1.093v-3.149a1.093 1.093 0 0 1 1.093-1.094","data-name":"Path 54"}),l.createElement("g",{"data-name":"Group 5",transform:"translate(12.202 16.584)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 52",rx:1}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 53",rx:1,transform:"translate(6.324)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 54",rx:1,transform:"translate(12.647)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 55",rx:1,transform:"translate(18.971)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 56",rx:1,transform:"translate(25.295)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 57",rx:1,transform:"translate(31.619)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 58",rx:1,transform:"translate(37.942)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 59",rx:1,transform:"translate(44.265)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 60",rx:1,transform:"translate(50.589)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 61",rx:1,transform:"translate(56.912)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 62",rx:1,transform:"translate(63.236)"})),l.createElement("path",{fillRule:"evenodd",d:"M83.053 16.584h6.906a1.093 1.093 0 0 1 1.091 1.093v3.15a1.093 1.093 0 0 1-1.091 1.093h-6.907a1.093 1.093 0 0 1-1.093-1.093v-3.149a1.093 1.093 0 0 1 1.093-1.094Z","data-name":"Path 55"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 7",transform:"translate(1.531 29.627)"},l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 63",rx:1}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 64",rx:1,transform:"translate(6.324)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 65",rx:1,transform:"translate(12.647)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 66",rx:1,transform:"translate(18.971)"}),l.createElement("path",{fillRule:"evenodd",d:"M26.387 0h30.422a1.093 1.093 0 0 1 1.093 1.093v3.151a1.093 1.093 0 0 1-1.093 1.093H26.387a1.093 1.093 0 0 1-1.093-1.093V1.093A1.093 1.093 0 0 1 26.387 0m33.594 0h3.942a1.093 1.093 0 0 1 1.093 1.093v3.151a1.093 1.093 0 0 1-1.093 1.093h-3.942a1.093 1.093 0 0 1-1.093-1.093V1.093A1.093 1.093 0 0 1 59.981 0","data-name":"Path 56"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 67",rx:1,transform:"translate(66.003)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 68",rx:1,transform:"translate(72.327)"}),l.createElement("rect",{width:5.336,height:5.336,"data-name":"Rectangle 69",rx:1,transform:"translate(84.183)"}),l.createElement("path",{d:"M78.254 2.273v-1.18A1.093 1.093 0 0 1 79.347 0h3.15a1.093 1.093 0 0 1 1.093 1.093v1.18Z","data-name":"Path 57"}),l.createElement("path",{d:"M83.591 3.063v1.18a1.093 1.093 0 0 1-1.093 1.093h-3.15a1.093 1.093 0 0 1-1.093-1.093v-1.18Z","data-name":"Path 58"})),l.createElement("rect",{width:88.927,height:2.371,fill:"#4a4a4a","data-name":"Rectangle 70",rx:1.085,transform:"translate(1.925 1.17)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 71",opacity:.136,rx:.723,transform:"translate(4.1 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 72",opacity:.136,rx:.723,transform:"translate(10.923 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 73",opacity:.136,rx:.723,transform:"translate(16.173 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 74",opacity:.136,rx:.723,transform:"translate(21.421 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 75",opacity:.136,rx:.723,transform:"translate(26.671 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 76",opacity:.136,rx:.723,transform:"translate(33.232 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 77",opacity:.136,rx:.723,transform:"translate(38.48 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 78",opacity:.136,rx:.723,transform:"translate(43.73 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 79",opacity:.136,rx:.723,transform:"translate(48.978 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 80",opacity:.136,rx:.723,transform:"translate(55.54 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 81",opacity:.136,rx:.723,transform:"translate(60.788 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 82",opacity:.136,rx:.723,transform:"translate(66.038 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 83",opacity:.136,rx:.723,transform:"translate(72.599 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 84",opacity:.136,rx:.723,transform:"translate(77.847 1.566)"}),l.createElement("rect",{width:4.986,height:1.581,fill:"#d8d8d8","data-name":"Rectangle 85",opacity:.136,rx:.723,transform:"translate(83.097 1.566)"})),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M408.256 591.563a5.4 5.4 0 0 0-.7.07c-.042-.164-.081-.329-.127-.493a5.457 5.457 0 1 0-5.4-9.372q-.181-.185-.366-.367a5.454 5.454 0 1 0-9.384-5.4c-.162-.046-.325-.084-.486-.126a5.467 5.467 0 1 0-10.788 0c-.162.042-.325.08-.486.126a5.457 5.457 0 1 0-9.384 5.4 21.843 21.843 0 1 0 36.421 21.02 5.452 5.452 0 1 0 .7-10.858","data-name":"Path 59"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M342.691 553.317h43.71v-21.855h-43.71Z","data-name":"Path 60"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M397.328 545.121a2.732 2.732 0 1 0 0-5.464 3 3 0 0 0-.349.035c-.022-.082-.04-.164-.063-.246a2.733 2.733 0 0 0-1.052-5.253 2.7 2.7 0 0 0-1.648.566q-.09-.093-.184-.184a2.7 2.7 0 0 0 .553-1.633 2.732 2.732 0 0 0-5.245-1.07 10.928 10.928 0 1 0 0 21.031 2.732 2.732 0 0 0 5.245-1.07 2.7 2.7 0 0 0-.553-1.633q.093-.09.184-.184a2.7 2.7 0 0 0 1.648.566 2.732 2.732 0 0 0 1.052-5.253q.033-.122.063-.246a3 3 0 0 0 .349.035","data-name":"Path 61"}),l.createElement("path",{fillRule:"evenodd",d:"M408.256 464.531a3 3 0 0 1-.535-.055 2.8 2.8 0 0 1-.514-.153 3 3 0 0 1-.471-.251 4 4 0 0 1-.415-.339 3 3 0 0 1-.338-.415 2.7 2.7 0 0 1-.459-1.517 3 3 0 0 1 .055-.535 3 3 0 0 1 .152-.514 3 3 0 0 1 .252-.47 2.6 2.6 0 0 1 .753-.754 3 3 0 0 1 .471-.251 2.8 2.8 0 0 1 .514-.153 2.5 2.5 0 0 1 1.071 0 2.7 2.7 0 0 1 .983.4 4 4 0 0 1 .415.339 4 4 0 0 1 .339.415 3 3 0 0 1 .251.47 2.9 2.9 0 0 1 .208 1.049 2.77 2.77 0 0 1-.8 1.934 4 4 0 0 1-.415.339 2.72 2.72 0 0 1-1.519.459m21.855-1.366a2.8 2.8 0 0 1-1.935-.8 4 4 0 0 1-.338-.415 2.7 2.7 0 0 1-.459-1.519 2.8 2.8 0 0 1 .8-1.934 4 4 0 0 1 .415-.339 3 3 0 0 1 .471-.251 2.8 2.8 0 0 1 .514-.153 2.5 2.5 0 0 1 1.071 0 2.7 2.7 0 0 1 .983.4 4 4 0 0 1 .415.339 2.8 2.8 0 0 1 .8 1.934 3 3 0 0 1-.055.535 3 3 0 0 1-.153.514 4 4 0 0 1-.251.47 4 4 0 0 1-.339.415 4 4 0 0 1-.415.339 2.72 2.72 0 0 1-1.519.459","data-name":"Path 62"}))))}},6740:(e,a,t)=>{t.d(a,{A:()=>c});var r,l=t(6540);function n(){return n=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...c}=e;return l.createElement("svg",n({xmlns:"http://www.w3.org/2000/svg",width:1041.277,height:554.141,viewBox:"0 0 1041.277 554.141","aria-labelledby":t},c),void 0===a?l.createElement("title",{id:t},"Powered by React"):a?l.createElement("title",{id:t},a):null,r||(r=l.createElement("g",{"data-name":"Group 24"},l.createElement("g",{"data-name":"Group 23",transform:"translate(-.011 -.035)"},l.createElement("path",{fill:"#f2f2f2",d:"M961.48 438.21q-1.74 3.75-3.47 7.4-2.7 5.67-5.33 11.12c-.78 1.61-1.56 3.19-2.32 4.77-8.6 17.57-16.63 33.11-23.45 45.89a73.21 73.21 0 0 1-63.81 38.7l-151.65 1.65h-1.6l-13 .14-11.12.12-34.1.37h-1.38l-17.36.19h-.53l-107 1.16-95.51 1-11.11.12-69 .75h-.08l-44.75.48h-.48l-141.5 1.53-42.33.46a88 88 0 0 1-10.79-.54c-1.22-.14-2.44-.3-3.65-.49a87.38 87.38 0 0 1-51.29-27.54c-18.21-20.03-31.46-43.4-40.36-68.76q-1.93-5.49-3.6-11.12c-30.81-104.15 6.75-238.52 74.35-328.44q4.25-5.64 8.64-11l.07-.08c20.79-25.52 44.1-46.84 68.93-62 44-26.91 92.75-34.49 140.7-11.9 40.57 19.12 78.45 28.11 115.17 30.55 3.71.24 7.42.42 11.11.53 84.23 2.65 163.17-27.7 255.87-47.29 3.69-.78 7.39-1.55 11.12-2.28C763 .54 836.36-6.4 923.6 8.19a189 189 0 0 1 26.76 6.4q5.77 1.86 11.12 4c41.64 16.94 64.35 48.24 74 87.46q1.37 5.46 2.37 11.11c17.11 94.34-33 228.16-76.37 321.05","data-name":"Path 299"}),l.createElement("path",{d:"M497.02 445.61a95 95 0 0 1-1.87 11.12h93.7v-11.12Zm-78.25 62.81 11.11-.09v-27.47c-3.81-.17-7.52-.34-11.11-.52Zm-232.92-62.81v11.12h198.5v-11.12Zm849.68-339.52h-74V18.6q-5.35-2.17-11.12-4v91.49H696.87V13.67c-3.73.73-7.43 1.5-11.12 2.28v90.14H429.88V63.24c-3.69-.11-7.4-.29-11.11-.53v43.38H162.9v-62c-24.83 15.16-48.14 36.48-68.93 62h-.07v.08q-4.4 5.4-8.64 11h8.64v328.44h-83q1.66 5.63 3.6 11.12h79.39v93.62a87 87 0 0 0 12.2 2.79c1.21.19 2.43.35 3.65.49a88 88 0 0 0 10.79.54l42.33-.46v-97h255.91v94.21l11.11-.12v-94.07h255.87v91.36l11.12-.12v-91.24h253.49v4.77c.76-1.58 1.54-3.16 2.32-4.77q2.63-5.45 5.33-11.12 1.73-3.64 3.47-7.4v-321h76.42q-1.01-5.69-2.37-11.12M162.9 445.61V117.17h255.87v328.44Zm267 0V117.17h255.85v328.44Zm520.48 0H696.87V117.17h253.49Z","data-name":"Path 300",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l46.65-28 93.6-.78 2-.01.66-.01 2-.03 44.94-.37 2.01-.01.64-.01 2-.01 14.41-.12.38-.01 35.55-.3h.29l277.4-2.34 6.79-.05h.68l5.18-.05 37.65-.31 2-.03 1.85-.02h.96l11.71-.09 2.32-.03 3.11-.02 9.75-.09 15.47-.13 2-.02 3.48-.02h.65l74.71-.64Z","data-name":"Path 301"}),l.createElement("path",{d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l46.65-28 93.6-.78 2-.01.66-.01 2-.03 44.94-.37 2.01-.01.64-.01 2-.01 14.41-.12.38-.01 35.55-.3h.29l277.4-2.34 6.79-.05h.68l5.18-.05 37.65-.31 2-.03 1.85-.02h.96l11.71-.09 2.32-.03 3.11-.02 9.75-.09 15.47-.13 2-.02 3.48-.02h.65l74.71-.64Z","data-name":"Path 302",opacity:.2}),l.createElement("path",{fill:"#3f3d56",d:"M296.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 303"}),l.createElement("path",{d:"M296.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 304",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M298.1 483.66v24.49a6.13 6.13 0 0 1-3.5 5.54 6 6 0 0 1-2.5.6l-34.9.74a6 6 0 0 1-2.7-.57 6.12 6.12 0 0 1-3.57-5.57v-25.23Z","data-name":"Path 305"}),l.createElement("path",{fill:"#3f3d56",d:"M680.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 137"}),l.createElement("path",{d:"M680.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 138",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M678.92 483.65h47.17v31.5h-47.17z","data-name":"Rectangle 139"}),l.createElement("path",{d:"M298.09 483.65v4.97l-47.17 1.26v-6.23Z","data-name":"Path 306",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M381.35 312.36v168.2a4 4 0 0 1-3.85 3.95l-191.65 5.1h-.05a4 4 0 0 1-3.95-3.95v-173.3a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.95 3.95","data-name":"Path 307"}),l.createElement("path",{d:"M185.85 308.41v181.2h-.05a4 4 0 0 1-3.95-3.95v-173.3a4 4 0 0 1 3.95-3.95Z","data-name":"Path 308",opacity:.1}),l.createElement("path",{fill:"#39374d",d:"M194.59 319.15h177.5V467.4l-177.5 4Z","data-name":"Path 309"}),l.createElement("path",{d:"M726.09 483.65v6.41l-47.17-1.26v-5.15Z","data-name":"Path 310",opacity:.1}),l.createElement("path",{fill:"#65617d",d:"M788.35 312.36v173.3a4 4 0 0 1-4 3.95l-191.69-5.1a4 4 0 0 1-3.85-3.95v-168.2a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.99 3.95","data-name":"Path 311"}),l.createElement("path",{d:"M788.35 312.36v173.3a4 4 0 0 1-4 3.95v-181.2a4 4 0 0 1 4 3.95","data-name":"Path 312",opacity:.1}),l.createElement("path",{fill:"#39374d",d:"M775.59 319.15h-177.5V467.4l177.5 4Z","data-name":"Path 313"}),l.createElement("path",{fill:"#65617d",d:"M583.85 312.36v168.2a4 4 0 0 1-3.85 3.95l-191.65 5.1a4 4 0 0 1-4-3.95v-173.3a4 4 0 0 1 3.95-3.95h191.6a4 4 0 0 1 3.95 3.95","data-name":"Path 314"}),l.createElement("path",{fill:"#4267b2",d:"M397.09 319.15h177.5V467.4l-177.5 4Z","data-name":"Path 315"}),l.createElement("path",{d:"M863.09 533.65v13l-151.92 1.4-1.62.03-57.74.53-1.38.02-17.55.15h-.52l-106.98.99-175.61 1.63h-.15l-44.65.42-.48.01-198.4 1.82v-15l202.51-1.33h.48l40.99-.28h.19l283.08-1.87h.29l.17-.01h.47l4.79-.03h1.46l74.49-.5 4.4-.02.98-.01Z","data-name":"Path 316",opacity:.1}),l.createElement("circle",{cx:51.33,cy:51.33,r:51.33,fill:"#fbbebe","data-name":"Ellipse 111",transform:"translate(435.93 246.82)"}),l.createElement("path",{fill:"#fbbebe",d:"M538.6 377.16s-99.5 12-90 0c3.44-4.34 4.39-17.2 4.2-31.85-.06-4.45-.22-9.06-.45-13.65-1.1-22-3.75-43.5-3.75-43.5s87-41 77-8.5c-4 13.13-2.69 31.57.35 48.88.89 5.05 1.92 10 3 14.7a345 345 0 0 0 9.65 33.92","data-name":"Path 317"}),l.createElement("path",{fill:"#ff6584",d:"M506.13 373.09c11.51-2.13 23.7-6 34.53-1.54 2.85 1.17 5.47 2.88 8.39 3.86s6.12 1.22 9.16 1.91c10.68 2.42 19.34 10.55 24.9 20s8.44 20.14 11.26 30.72l6.9 25.83c6 22.45 12 45.09 13.39 68.3a2438 2438 0 0 1-250.84 1.43c5.44-10.34 11-21.31 10.54-33s-7.19-23.22-4.76-34.74c1.55-7.34 6.57-13.39 9.64-20.22 8.75-19.52 1.94-45.79 17.32-60.65 6.92-6.68 17-9.21 26.63-8.89 12.28.41 24.85 4.24 37 6.11 15.56 2.36 30.26 3.76 45.94.88","data-name":"Path 318"}),l.createElement("path",{d:"m637.03 484.26-.1 1.43v.1l-.17 2.3-1.33 18.51-1.61 22.3-.46 6.28-1 13.44v.17l-107 1-175.59 1.9v.84h-.14v-1.12l.45-14.36.86-28.06.74-23.79.07-2.37a10.53 10.53 0 0 1 11.42-10.17c4.72.4 10.85.89 18.18 1.41l3 .22c42.33 2.94 120.56 6.74 199.5 2 1.66-.09 3.33-.19 5-.31 12.24-.77 24.47-1.76 36.58-3a10.53 10.53 0 0 1 11.6 11.23Z","data-name":"Path 319",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"M349.74 552.53v-.84l175.62-1.91 107-1h.3v-.17l1-13.44.43-6 1.64-22.61 1.29-17.9v-.44a10.6 10.6 0 0 0-.11-2.47.3.3 0 0 0 0-.1 10.4 10.4 0 0 0-2-4.64 10.54 10.54 0 0 0-9.42-4 937 937 0 0 1-36.58 3c-1.67.12-3.34.22-5 .31-78.94 4.69-157.17.89-199.5-2l-3-.22c-7.33-.52-13.46-1-18.18-1.41a10.54 10.54 0 0 0-11.24 8.53 11 11 0 0 0-.18 1.64l-.68 22.16-.93 28.07-.44 14.36v1.12Z","data-name":"Path 320"}),l.createElement("path",{d:"m637.33 491.27-1.23 15.33-1.83 22.85-.46 5.72-1 12.81-.06.64v.17l-.15 1.48.11-1.48h-.29l-107 1-175.65 1.9v-.28l.49-14.36 1-28.06.64-18.65a6.36 6.36 0 0 1 3.06-5.25 6.25 6.25 0 0 1 3.78-.9c2.1.17 4.68.37 7.69.59 4.89.36 10.92.78 17.94 1.22 13 .82 29.31 1.7 48 2.42 52 2 122.2 2.67 188.88-3.17 3-.26 6.1-.55 9.13-.84a6.26 6.26 0 0 1 3.48.66 5 5 0 0 1 .86.54 6.14 6.14 0 0 1 2 2.46 3.6 3.6 0 0 1 .25.61 6.3 6.3 0 0 1 .36 2.59","data-name":"Path 321",opacity:.1}),l.createElement("path",{d:"M298.1 504.96v3.19a6.13 6.13 0 0 1-3.5 5.54l-40.1.77a6.12 6.12 0 0 1-3.57-5.57v-3Z","data-name":"Path 322",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m298.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 323"}),l.createElement("path",{d:"m298.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 324",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m300.59 515.57-52.25 1v-8.67l52.25-1Z","data-name":"Path 325"}),l.createElement("path",{d:"M679.22 506.96v3.19a6.13 6.13 0 0 0 3.5 5.54l40.1.77a6.12 6.12 0 0 0 3.57-5.57v-3Z","data-name":"Path 326",opacity:.1}),l.createElement("path",{d:"m678.72 517.57 52.25 1v-8.67l-52.25-1Z","data-name":"Path 327",opacity:.1}),l.createElement("path",{fill:"#3f3d56",d:"m676.72 517.57 52.25 1v-8.67l-52.25-1Z","data-name":"Path 328"}),l.createElement("path",{fill:"#3f3d56",d:"M454.79 313.88c.08 7-3.16 13.6-5.91 20.07a163.5 163.5 0 0 0-12.66 74.71c.73 11 2.58 22 .73 32.9s-8.43 21.77-19 24.9c17.53 10.45 41.26 9.35 57.76-2.66 8.79-6.4 15.34-15.33 21.75-24.11a97.86 97.86 0 0 1-13.31 44.75 103.43 103.43 0 0 0 73.51-40.82c4.31-5.81 8.06-12.19 9.72-19.23 3.09-13-1.22-26.51-4.51-39.5a266 266 0 0 1-6.17-33c-.43-3.56-.78-7.22.1-10.7 1-4.07 3.67-7.51 5.64-11.22 5.6-10.54 5.73-23.3 2.86-34.88s-8.49-22.26-14.06-32.81c-4.46-8.46-9.3-17.31-17.46-22.28-5.1-3.1-11-4.39-16.88-5.64l-25.37-5.43c-5.55-1.19-11.26-2.38-16.87-1.51-9.47 1.48-16.14 8.32-22 15.34-4.59 5.46-15.81 15.71-16.6 22.86-.72 6.59 5.1 17.63 6.09 24.58 1.3 9 2.22 6 7.3 11.52 3.21 3.42 5.28 7.37 5.34 12.16","data-name":"Path 329"})),l.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M280.139 370.832h43.635v17.662h-43.635Z","data-name":"Path 40"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M240.66 428.493a10.38 10.38 0 0 1-8.989-5.195 10.377 10.377 0 0 0 8.988 15.584h10.391v-10.389Z","data-name":"Path 41"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m287.402 373.625 36.373-2.273v-5.195a10.39 10.39 0 0 0-10.39-10.389h-46.75l-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249-1.3-2.249a1.5 1.5 0 0 0-2.6 0l-1.3 2.249h-.034l-2.152-2.151a1.5 1.5 0 0 0-2.508.672l-.696 2.653-2.7-.723a1.5 1.5 0 0 0-1.836 1.837l.722 2.7-2.65.71a1.5 1.5 0 0 0-.673 2.509l2.152 2.152v.033l-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.25 1.282-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3-2.249 1.3a1.5 1.5 0 0 0 0 2.6l2.249 1.3a10.39 10.39 0 0 0 10.389 10.34h62.335a10.39 10.39 0 0 0 10.39-10.39v-41.557l-36.373-2.273a5.53 5.53 0 0 1 0-11.038","data-name":"Path 42"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M302.996 438.882h15.584v-20.779h-15.584Z","data-name":"Path 43"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M328.97 425.895a3 3 0 0 0-.332.033q-.028-.117-.06-.234a2.594 2.594 0 1 0-2.567-4.455q-.086-.088-.174-.175a2.593 2.593 0 1 0-4.461-2.569q-.115-.031-.231-.06a2.6 2.6 0 1 0-5.128 0q-.116.029-.231.06a2.594 2.594 0 1 0-4.461 2.569 10.384 10.384 0 1 0 17.314 9.992 2.592 2.592 0 1 0 .332-5.161","data-name":"Path 44"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.191 407.713h15.584v-10.389h-15.584Z","data-name":"Path 45"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M328.969 403.818a1.3 1.3 0 1 0 0-2.6 1 1 0 0 0-.166.017l-.03-.117a1.3 1.3 0 0 0-.5-2.5 1.3 1.3 0 0 0-.783.269l-.087-.087a1.3 1.3 0 0 0 .263-.776 1.3 1.3 0 0 0-2.493-.509 5.195 5.195 0 1 0 0 10 1.3 1.3 0 0 0 2.493-.509 1.3 1.3 0 0 0-.263-.776l.087-.087a1.3 1.3 0 0 0 .783.269 1.3 1.3 0 0 0 .5-2.5q.016-.058.03-.117a1 1 0 0 0 .166.017","data-name":"Path 46"}),l.createElement("path",{fillRule:"evenodd",d:"M261.439 372.65a1.3 1.3 0 0 1-1.3-1.3 3.9 3.9 0 0 0-7.792 0 1.3 1.3 0 1 1-2.6 0 6.494 6.494 0 0 1 12.987 0 1.3 1.3 0 0 1-1.3 1.3","data-name":"Path 47"}),l.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M282.217 438.882h31.168a10.39 10.39 0 0 0 10.389-10.389V392.13h-31.168a10.39 10.39 0 0 0-10.389 10.389Z","data-name":"Path 48"}),l.createElement("path",{fillRule:"evenodd",d:"M315.993 408.233h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0-25.877h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.293h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m0 10.389h-25.994a.52.52 0 1 1 0-1.039h25.994a.52.52 0 0 1 0 1.039m7.782-47.993h-.018c-1.605.055-2.365 1.66-3.035 3.077-.7 1.48-1.24 2.443-2.126 2.414-.981-.035-1.542-1.144-2.137-2.317-.683-1.347-1.462-2.876-3.1-2.819-1.582.054-2.344 1.451-3.017 2.684-.715 1.313-1.2 2.112-2.141 2.075-1-.036-1.533-.938-2.149-1.981-.686-1.162-1.479-2.467-3.084-2.423-1.555.053-2.319 1.239-2.994 2.286-.713 1.106-1.213 1.781-2.164 1.741-1.025-.036-1.554-.784-2.167-1.65-.688-.973-1.463-2.074-3.062-2.021a3.82 3.82 0 0 0-2.959 1.879c-.64.812-1.14 1.456-2.2 1.415a.52.52 0 0 0-.037 1.039 3.59 3.59 0 0 0 3.05-1.811c.611-.777 1.139-1.448 2.178-1.483 1-.043 1.47.579 2.179 1.582.674.953 1.438 2.033 2.977 2.089 1.612.054 2.387-1.151 3.074-2.217.614-.953 1.144-1.775 2.156-1.81.931-.035 1.438.7 2.153 1.912.674 1.141 1.437 2.434 3.006 2.491 1.623.056 2.407-1.361 3.09-2.616.592-1.085 1.15-2.109 2.14-2.143.931-.022 1.417.829 2.135 2.249.671 1.326 1.432 2.828 3.026 2.886h.088c1.592 0 2.347-1.6 3.015-3.01.592-1.252 1.152-2.431 2.113-2.479Z","data-name":"Path 49"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M271.828 438.882h20.779v-20.779h-20.779Z","data-name":"Path 50"}),l.createElement("g",{"data-name":"Group 8",transform:"rotate(-14.98 1643.944 -873.93)"},l.createElement("rect",{width:43.906,height:17.333,fill:"#d8d8d8","data-name":"Rectangle 3",rx:2}),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 2",transform:"translate(.728 10.948)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 4",rx:1,transform:"translate(7.985)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 5",rx:1,transform:"translate(10.991)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 6",rx:1,transform:"translate(13.997)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 7",rx:1,transform:"translate(17.003)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 8",rx:1,transform:"translate(20.009)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 9",rx:1,transform:"translate(23.015)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 10",rx:1,transform:"translate(26.021)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 11",rx:1,transform:"translate(29.028)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 12",rx:1,transform:"translate(32.034)"}),l.createElement("path",{fillRule:"evenodd",d:"M.519 0H6.9a.52.52 0 0 1 .521.52v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0m35.134 0h6.383a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-6.384a.52.52 0 0 1-.519-.519v-1.5A.52.52 0 0 1 35.652 0Z","data-name":"Path 51"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 3",transform:"translate(.728 4.878)"},l.createElement("path",{fillRule:"evenodd",d:"M.519 0h2.437a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0","data-name":"Path 52"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 13",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 14",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 15",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 16",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 17",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 18",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 19",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 20",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 21",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 22",rx:1,transform:"translate(31)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 23",rx:1,transform:"translate(34.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 24",rx:1,transform:"translate(37.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 25",rx:1,transform:"translate(40.018)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 4",transform:"rotate(180 21.642 2.269)"},l.createElement("path",{fillRule:"evenodd",d:"M.519 0h2.437a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H.519A.52.52 0 0 1 0 2.017V.519A.52.52 0 0 1 .519 0","data-name":"Path 53"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 26",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 27",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 28",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 29",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 30",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 31",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 32",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 33",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 34",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 35",rx:1,transform:"translate(31.001)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 36",rx:1,transform:"translate(34.007)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 37",rx:1,transform:"translate(37.013)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 38",rx:1,transform:"translate(40.018)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 39",rx:1,transform:"translate(3.945)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 40",rx:1,transform:"translate(6.951)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 41",rx:1,transform:"translate(9.958)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 42",rx:1,transform:"translate(12.964)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 43",rx:1,transform:"translate(15.97)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 44",rx:1,transform:"translate(18.976)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 45",rx:1,transform:"translate(21.982)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 46",rx:1,transform:"translate(24.988)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 47",rx:1,transform:"translate(27.994)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 48",rx:1,transform:"translate(31.001)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 49",rx:1,transform:"translate(34.007)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 50",rx:1,transform:"translate(37.013)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 51",rx:1,transform:"translate(40.018)"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 6"},l.createElement("path",{fillRule:"evenodd",d:"M1.247 7.883h3.47a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-3.47A.52.52 0 0 1 .728 9.9V8.403a.52.52 0 0 1 .519-.52","data-name":"Path 54"}),l.createElement("g",{"data-name":"Group 5",transform:"translate(5.801 7.883)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 52",rx:1}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 53",rx:1,transform:"translate(3.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 54",rx:1,transform:"translate(6.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 55",rx:1,transform:"translate(9.018)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 56",rx:1,transform:"translate(12.025)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 57",rx:1,transform:"translate(15.031)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 58",rx:1,transform:"translate(18.037)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 59",rx:1,transform:"translate(21.042)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 60",rx:1,transform:"translate(24.049)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 61",rx:1,transform:"translate(27.055)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 62",rx:1,transform:"translate(30.061)"})),l.createElement("path",{fillRule:"evenodd",d:"M39.482 7.883h3.28a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-3.281a.52.52 0 0 1-.519-.521V8.403a.52.52 0 0 1 .519-.52Z","data-name":"Path 55"})),l.createElement("g",{fill:"#4a4a4a","data-name":"Group 7",transform:"translate(.728 14.084)"},l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 63",rx:1}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 64",rx:1,transform:"translate(3.006)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 65",rx:1,transform:"translate(6.012)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 66",rx:1,transform:"translate(9.018)"}),l.createElement("path",{fillRule:"evenodd",d:"M12.543 0h14.462a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519H12.543a.52.52 0 0 1-.519-.52V.519A.52.52 0 0 1 12.543 0m15.97 0h1.874a.52.52 0 0 1 .519.519v1.5a.52.52 0 0 1-.519.519h-1.874a.52.52 0 0 1-.519-.519v-1.5A.52.52 0 0 1 28.513 0","data-name":"Path 56"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 67",rx:1,transform:"translate(31.376)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 68",rx:1,transform:"translate(34.382)"}),l.createElement("rect",{width:2.537,height:2.537,"data-name":"Rectangle 69",rx:1,transform:"translate(40.018)"}),l.createElement("path",{d:"M37.199 1.08V.519A.52.52 0 0 1 37.718 0h1.499a.52.52 0 0 1 .519.519v.561Z","data-name":"Path 57"}),l.createElement("path",{d:"M39.737 1.456v.561a.52.52 0 0 1-.519.519h-1.499a.52.52 0 0 1-.519-.519v-.561Z","data-name":"Path 58"})),l.createElement("rect",{width:42.273,height:1.127,fill:"#4a4a4a","data-name":"Rectangle 70",rx:.564,transform:"translate(.915 .556)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 71",opacity:.136,rx:.376,transform:"translate(1.949 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 72",opacity:.136,rx:.376,transform:"translate(5.193 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 73",opacity:.136,rx:.376,transform:"translate(7.688 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 74",opacity:.136,rx:.376,transform:"translate(10.183 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 75",opacity:.136,rx:.376,transform:"translate(12.679 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 76",opacity:.136,rx:.376,transform:"translate(15.797 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 77",opacity:.136,rx:.376,transform:"translate(18.292 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 78",opacity:.136,rx:.376,transform:"translate(20.788 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 79",opacity:.136,rx:.376,transform:"translate(23.283 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 80",opacity:.136,rx:.376,transform:"translate(26.402 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 81",opacity:.136,rx:.376,transform:"translate(28.897 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 82",opacity:.136,rx:.376,transform:"translate(31.393 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 83",opacity:.136,rx:.376,transform:"translate(34.512 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 84",opacity:.136,rx:.376,transform:"translate(37.007 .744)"}),l.createElement("rect",{width:2.37,height:.752,fill:"#d8d8d8","data-name":"Rectangle 85",opacity:.136,rx:.376,transform:"translate(39.502 .744)"})),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M302.996 425.895a3 3 0 0 0-.332.033q-.029-.117-.06-.234a2.594 2.594 0 1 0-2.567-4.455q-.086-.088-.174-.175a2.593 2.593 0 1 0-4.461-2.569q-.116-.031-.231-.06a2.6 2.6 0 1 0-5.128 0q-.115.029-.231.06a2.594 2.594 0 1 0-4.461 2.569 10.384 10.384 0 1 0 17.314 9.992 2.592 2.592 0 1 0 .332-5.161","data-name":"Path 59"}),l.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M271.828 407.713h20.779v-10.389h-20.779Z","data-name":"Path 60"}),l.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M297.801 403.818a1.3 1.3 0 1 0 0-2.6 1 1 0 0 0-.166.017l-.03-.117a1.3 1.3 0 0 0-.5-2.5 1.3 1.3 0 0 0-.783.269l-.087-.087a1.3 1.3 0 0 0 .263-.776 1.3 1.3 0 0 0-2.493-.509 5.195 5.195 0 1 0 0 10 1.3 1.3 0 0 0 2.493-.509 1.3 1.3 0 0 0-.263-.776l.087-.087a1.3 1.3 0 0 0 .783.269 1.3 1.3 0 0 0 .5-2.5q.016-.058.03-.117a1 1 0 0 0 .166.017","data-name":"Path 61"}),l.createElement("path",{fillRule:"evenodd",d:"M302.997 365.507a1.4 1.4 0 0 1-.255-.026 1.3 1.3 0 0 1-.244-.073 1.4 1.4 0 0 1-.224-.119 2 2 0 0 1-.2-.161 1.5 1.5 0 0 1-.161-.2 1.3 1.3 0 0 1-.218-.722 1.4 1.4 0 0 1 .026-.255 1.5 1.5 0 0 1 .072-.244 1.4 1.4 0 0 1 .12-.223 1.3 1.3 0 0 1 .358-.358 1.4 1.4 0 0 1 .224-.119 1.3 1.3 0 0 1 .244-.073 1.2 1.2 0 0 1 .509 0 1.3 1.3 0 0 1 .468.192 2 2 0 0 1 .2.161 2 2 0 0 1 .161.2 1.3 1.3 0 0 1 .12.223 1.4 1.4 0 0 1 .1.5 1.32 1.32 0 0 1-.379.919 2 2 0 0 1-.2.161 1.4 1.4 0 0 1-.223.119 1.3 1.3 0 0 1-.5.1m10.389-.649a1.33 1.33 0 0 1-.92-.379 2 2 0 0 1-.161-.2 1.3 1.3 0 0 1-.218-.722 1.33 1.33 0 0 1 .379-.919 2 2 0 0 1 .2-.161 1.4 1.4 0 0 1 .224-.119 1.3 1.3 0 0 1 .244-.073 1.2 1.2 0 0 1 .509 0 1.3 1.3 0 0 1 .468.192 2 2 0 0 1 .2.161 1.33 1.33 0 0 1 .379.919 1.5 1.5 0 0 1-.026.255 1.3 1.3 0 0 1-.073.244 2 2 0 0 1-.119.223 2 2 0 0 1-.161.2 2 2 0 0 1-.2.161 1.3 1.3 0 0 1-.722.218","data-name":"Path 62"}),l.createElement("g",{fill:"#61dafb",transform:"translate(466.3 278.56)"},l.createElement("path",{d:"M263.668 117.179c0-5.827-7.3-11.35-18.487-14.775 2.582-11.4 1.434-20.477-3.622-23.382a7.86 7.86 0 0 0-4.016-1v4a4.15 4.15 0 0 1 2.044.466c2.439 1.4 3.5 6.724 2.672 13.574-.2 1.685-.52 3.461-.914 5.272a87 87 0 0 0-11.386-1.954 87.5 87.5 0 0 0-7.459-8.965c5.845-5.433 11.332-8.41 15.062-8.41V78c-4.931 0-11.386 3.514-17.913 9.611-6.527-6.061-12.982-9.539-17.913-9.539v4c3.712 0 9.216 2.959 15.062 8.356a85 85 0 0 0-7.405 8.947 84 84 0 0 0-11.4 1.972 54 54 0 0 1-.932-5.2c-.843-6.85.2-12.175 2.618-13.592a4 4 0 0 1 2.062-.466v-4a8 8 0 0 0-4.052 1c-5.039 2.9-6.168 11.96-3.568 23.328-11.153 3.443-18.415 8.947-18.415 14.757 0 5.828 7.3 11.35 18.487 14.775-2.582 11.4-1.434 20.477 3.622 23.382a7.9 7.9 0 0 0 4.034 1c4.931 0 11.386-3.514 17.913-9.611 6.527 6.061 12.982 9.539 17.913 9.539a8 8 0 0 0 4.052-1c5.039-2.9 6.168-11.96 3.568-23.328 11.111-3.42 18.373-8.943 18.373-14.752m-23.346-11.96a80 80 0 0 1-2.421 7.083 83 83 0 0 0-2.349-4.3 97 97 0 0 0-2.582-4.2c2.547.377 5.004.843 7.353 1.417Zm-8.212 19.1c-1.4 2.421-2.833 4.716-4.321 6.85a93 93 0 0 1-8.1.359c-2.708 0-5.415-.126-8.069-.341q-2.232-3.2-4.339-6.814-2.044-3.523-3.73-7.136a94 94 0 0 1 3.712-7.154c1.4-2.421 2.833-4.716 4.321-6.85a93 93 0 0 1 8.1-.359c2.708 0 5.415.126 8.069.341q2.232 3.2 4.339 6.814 2.044 3.523 3.73 7.136a101 101 0 0 1-3.712 7.15Zm5.792-2.331a77 77 0 0 1 2.474 7.136 80 80 0 0 1-7.387 1.434c.879-1.381 1.757-2.8 2.582-4.25a96 96 0 0 0 2.329-4.324Zm-18.182 19.128a74 74 0 0 1-4.985-5.738c1.614.072 3.263.126 4.931.126 1.685 0 3.353-.036 4.985-.126a70 70 0 0 1-4.931 5.738m-13.34-10.561c-2.546-.377-5-.843-7.352-1.417a80 80 0 0 1 2.421-7.083c.735 1.434 1.506 2.869 2.349 4.3s1.702 2.837 2.582 4.2m13.25-37.314a74 74 0 0 1 4.985 5.738 111 111 0 0 0-4.931-.126c-1.686 0-3.353.036-4.985.126a70 70 0 0 1 4.931-5.738M206.362 103.8a101 101 0 0 0-4.913 8.55 77 77 0 0 1-2.474-7.136 90 90 0 0 1 7.387-1.414m-16.227 22.449c-6.348-2.708-10.454-6.258-10.454-9.073s4.106-6.383 10.454-9.073c1.542-.663 3.228-1.255 4.967-1.811a86 86 0 0 0 4.034 10.92 85 85 0 0 0-3.981 10.866 54 54 0 0 1-5.021-1.826Zm9.647 25.623c-2.439-1.4-3.5-6.724-2.672-13.574.2-1.686.52-3.461.914-5.272a87 87 0 0 0 11.386 1.954 87.5 87.5 0 0 0 7.459 8.965c-5.845 5.433-11.332 8.41-15.062 8.41a4.3 4.3 0 0 1-2.026-.48Zm42.532-13.663c.843 6.85-.2 12.175-2.618 13.592a4 4 0 0 1-2.062.466c-3.712 0-9.216-2.959-15.062-8.356a85 85 0 0 0 7.405-8.947 84 84 0 0 0 11.4-1.972 50 50 0 0 1 .936 5.22Zm6.9-11.96c-1.542.663-3.228 1.255-4.967 1.811a86 86 0 0 0-4.034-10.92 85 85 0 0 0 3.981-10.866 57 57 0 0 1 5.039 1.829c6.348 2.708 10.454 6.258 10.454 9.073-.017 2.818-4.123 6.386-10.471 9.076Z","data-name":"Path 330"}),l.createElement("path",{d:"M201.718 78.072","data-name":"Path 331"}),l.createElement("circle",{cx:8.194,cy:8.194,r:8.194,"data-name":"Ellipse 112",transform:"translate(211.472 108.984)"}),l.createElement("path",{d:"M237.525 78.018","data-name":"Path 332"})))))}},3844:(e,a,t)=>{t.d(a,{A:()=>T});var r,l,n,c,h,d,m,i,s,o,f,g,E,p,x,v,R,w,u,y,M,P,b,Z,j,A,q,N,V,H,k,G,C,O,S,z,F=t(6540);function _(){return _=Object.assign?Object.assign.bind():function(e){for(var a=1;a{let{title:a,titleId:t,...T}=e;return F.createElement("svg",_({xmlns:"http://www.w3.org/2000/svg",width:1129,height:663,viewBox:"0 0 1129 663","aria-labelledby":t},T),void 0===a?F.createElement("title",{id:t},"Focus on What Matters"):a?F.createElement("title",{id:t},a):null,r||(r=F.createElement("circle",{cx:321,cy:321,r:321,fill:"#f2f2f2"})),l||(l=F.createElement("ellipse",{cx:559,cy:635.5,fill:"#3f3d56",rx:514,ry:27.5})),n||(n=F.createElement("ellipse",{cx:558,cy:627,opacity:.2,rx:460,ry:22})),c||(c=F.createElement("path",{fill:"#3f3d56",d:"M131 152.5h840v50H131z"})),h||(h=F.createElement("path",{fill:"#3f3d56",d:"M131 608.83a21.67 21.67 0 0 0 21.67 21.67h796.66A21.67 21.67 0 0 0 971 608.83V177.5H131ZM949.33 117.5H152.67A21.67 21.67 0 0 0 131 139.17v38.33h840v-38.33a21.67 21.67 0 0 0-21.67-21.67"})),d||(d=F.createElement("path",{d:"M949.33 117.5H152.67A21.67 21.67 0 0 0 131 139.17v38.33h840v-38.33a21.67 21.67 0 0 0-21.67-21.67",opacity:.2})),m||(m=F.createElement("circle",{cx:181,cy:147.5,r:13,fill:"#3f3d56"})),i||(i=F.createElement("circle",{cx:217,cy:147.5,r:13,fill:"#3f3d56"})),s||(s=F.createElement("circle",{cx:253,cy:147.5,r:13,fill:"#3f3d56"})),o||(o=F.createElement("rect",{width:337,height:386,x:168,y:213.5,fill:"#606060",rx:5.335})),f||(f=F.createElement("rect",{width:284,height:22,x:603,y:272.5,fill:"#2e8555",rx:5.476})),g||(g=F.createElement("rect",{width:416,height:15,x:537,y:352.5,fill:"#2e8555",rx:5.476})),E||(E=F.createElement("rect",{width:416,height:15,x:537,y:396.5,fill:"#2e8555",rx:5.476})),p||(p=F.createElement("rect",{width:416,height:15,x:537,y:440.5,fill:"#2e8555",rx:5.476})),x||(x=F.createElement("rect",{width:416,height:15,x:537,y:484.5,fill:"#2e8555",rx:5.476})),v||(v=F.createElement("rect",{width:88,height:26,x:865,y:552.5,fill:"#3ecc5f",rx:7.028})),R||(R=F.createElement("path",{fill:"#3f3d56",d:"M1053.103 506.116a30.1 30.1 0 0 0 3.983-15.266c0-13.797-8.544-24.98-19.083-24.98s-19.082 11.183-19.082 24.98a30.1 30.1 0 0 0 3.983 15.266 31.25 31.25 0 0 0 0 30.532 31.25 31.25 0 0 0 0 30.532 31.25 31.25 0 0 0 0 30.532 30.1 30.1 0 0 0-3.983 15.266c0 13.797 8.543 24.981 19.082 24.981s19.083-11.184 19.083-24.98a30.1 30.1 0 0 0-3.983-15.267 31.25 31.25 0 0 0 0-30.532 31.25 31.25 0 0 0 0-30.532 31.25 31.25 0 0 0 0-30.532"})),w||(w=F.createElement("ellipse",{cx:1038.003,cy:460.318,fill:"#3f3d56",rx:19.083,ry:24.981})),u||(u=F.createElement("ellipse",{cx:1038.003,cy:429.786,fill:"#3f3d56",rx:19.083,ry:24.981})),y||(y=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M1109.439 220.845a92 92 0 0 0 7.106-10.461l-50.14-8.235 54.228.403a91.57 91.57 0 0 0 1.746-72.426l-72.755 37.742 67.097-49.321A91.413 91.413 0 1 0 965.75 220.845a91.5 91.5 0 0 0-10.425 16.67l65.087 33.814-69.4-23.292a91.46 91.46 0 0 0 14.738 85.837 91.406 91.406 0 1 0 143.689 0 91.42 91.42 0 0 0 0-113.03"})),M||(M=F.createElement("path",{d:"M946.189 277.36a91 91 0 0 0 19.56 56.514 91.406 91.406 0 1 0 143.69 0c12.25-15.553-163.25-66.774-163.25-56.515",opacity:.1})),P||(P=F.createElement("path",{fill:"#fff",fillRule:"evenodd",d:"M330.12 342.936h111.474v45.12H330.12Z"})),b||(b=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M229.263 490.241a26.51 26.51 0 0 1-22.963-13.27 26.51 26.51 0 0 0 22.963 39.812h26.541V490.24Z"})),Z||(Z=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"m348.672 350.07 92.922-5.807v-13.27a26.54 26.54 0 0 0-26.541-26.542H295.616l-3.318-5.746a3.83 3.83 0 0 0-6.635 0l-3.318 5.746-3.317-5.746a3.83 3.83 0 0 0-6.636 0l-3.317 5.746-3.318-5.746a3.83 3.83 0 0 0-6.635 0l-3.318 5.746c-.03 0-.056.004-.086.004l-5.497-5.495a3.83 3.83 0 0 0-6.407 1.717l-1.817 6.773-6.89-1.847a3.83 3.83 0 0 0-4.691 4.693l1.844 6.891-6.77 1.814a3.832 3.832 0 0 0-1.72 6.41l5.497 5.497q-.002.041-.004.085l-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318-5.747 3.317a3.83 3.83 0 0 0 0 6.636l5.747 3.317-5.747 3.318a3.83 3.83 0 0 0 0 6.635l5.747 3.318a26.54 26.54 0 0 0 26.541 26.542h159.249a26.54 26.54 0 0 0 26.541-26.542V384.075l-92.922-5.807a14.126 14.126 0 0 1 0-28.197"})),j||(j=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M388.511 516.783h39.812V463.7h-39.812Z"})),A||(A=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M454.865 483.606a7 7 0 0 0-.848.085q-.073-.3-.154-.599a6.627 6.627 0 1 0-6.557-11.382q-.22-.225-.445-.446a6.624 6.624 0 1 0-11.397-6.564c-.196-.055-.394-.102-.59-.152a6.64 6.64 0 1 0-13.101 0c-.197.05-.394.097-.59.152a6.628 6.628 0 1 0-11.398 6.564 26.528 26.528 0 1 0 44.232 25.528 6.621 6.621 0 1 0 .848-13.186"})),q||(q=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M401.782 437.158h39.812v-26.541h-39.812Z"})),N||(N=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M454.865 427.205a3.318 3.318 0 0 0 0-6.635 3 3 0 0 0-.424.042c-.026-.1-.049-.199-.077-.298a3.319 3.319 0 0 0-1.278-6.38 3.28 3.28 0 0 0-2 .688q-.11-.113-.224-.223a3.3 3.3 0 0 0 .672-1.983 3.318 3.318 0 0 0-6.37-1.299 13.27 13.27 0 1 0 0 25.541 3.318 3.318 0 0 0 6.37-1.3 3.3 3.3 0 0 0-.672-1.982q.114-.11.223-.223a3.28 3.28 0 0 0 2.001.688 3.318 3.318 0 0 0 1.278-6.38c.028-.098.05-.199.077-.298a3 3 0 0 0 .424.042"})),V||(V=F.createElement("path",{fillRule:"evenodd",d:"M282.345 347.581a3.32 3.32 0 0 1-3.317-3.318 9.953 9.953 0 1 0-19.906 0 3.318 3.318 0 1 1-6.636 0 16.588 16.588 0 1 1 33.177 0 3.32 3.32 0 0 1-3.318 3.318"})),H||(H=F.createElement("path",{fill:"#ffff50",fillRule:"evenodd",d:"M335.428 516.783h79.625a26.54 26.54 0 0 0 26.541-26.542v-92.895H361.97a26.54 26.54 0 0 0-26.542 26.542Z"})),k||(k=F.createElement("path",{fillRule:"evenodd",d:"M421.714 438.485h-66.406a1.327 1.327 0 0 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.542h-66.406a1.327 1.327 0 1 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.541h-66.406a1.327 1.327 0 1 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0-66.106h-66.406a1.327 1.327 0 0 1 0-2.655h66.406a1.327 1.327 0 0 1 0 2.655m0 26.294h-66.406a1.327 1.327 0 0 1 0-2.654h66.406a1.327 1.327 0 0 1 0 2.654m0 26.542h-66.406a1.327 1.327 0 0 1 0-2.655h66.406a1.327 1.327 0 0 1 0 2.655m19.88-122.607c-.016 0-.03-.008-.045-.007-4.1.14-6.04 4.241-7.753 7.86-1.786 3.783-3.168 6.242-5.432 6.167-2.506-.09-3.94-2.922-5.458-5.918-1.744-3.443-3.734-7.347-7.913-7.201-4.042.138-5.99 3.708-7.706 6.857-1.828 3.355-3.071 5.394-5.47 5.3-2.557-.093-3.916-2.395-5.488-5.06-1.753-2.967-3.78-6.304-7.878-6.19-3.973.137-5.925 3.166-7.648 5.84-1.822 2.826-3.098 4.549-5.527 4.447-2.618-.093-3.97-2.004-5.535-4.216-1.757-2.486-3.737-5.3-7.823-5.163-3.886.133-5.838 2.615-7.56 4.802-1.634 2.075-2.91 3.718-5.611 3.615a1.328 1.328 0 1 0-.096 2.654c4.004.134 6.032-2.389 7.793-4.628 1.562-1.985 2.91-3.698 5.564-3.789 2.556-.108 3.754 1.48 5.567 4.041 1.721 2.434 3.675 5.195 7.606 5.337 4.118.138 6.099-2.94 7.853-5.663 1.569-2.434 2.923-4.535 5.508-4.624 2.38-.088 3.674 1.792 5.5 4.885 1.722 2.916 3.671 6.22 7.68 6.365 4.147.143 6.15-3.477 7.895-6.682 1.511-2.77 2.938-5.388 5.466-5.475 2.38-.056 3.62 2.116 5.456 5.746 1.714 3.388 3.658 7.226 7.73 7.373l.224.004c4.066 0 5.996-4.08 7.704-7.689 1.511-3.198 2.942-6.21 5.397-6.334Z"})),G||(G=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.887 516.783h53.083V463.7h-53.083Z"})),C||(C=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M388.511 483.606a7 7 0 0 0-.848.085c-.05-.2-.098-.4-.154-.599a6.627 6.627 0 1 0-6.557-11.382q-.22-.225-.444-.446a6.624 6.624 0 1 0-11.397-6.564c-.197-.055-.394-.102-.59-.152a6.64 6.64 0 1 0-13.102 0c-.196.05-.394.097-.59.152a6.628 6.628 0 1 0-11.397 6.564 26.528 26.528 0 1 0 44.231 25.528 6.621 6.621 0 1 0 .848-13.186"})),O||(O=F.createElement("path",{fill:"#3ecc5f",fillRule:"evenodd",d:"M308.887 437.158h53.083v-26.541h-53.083Z"})),S||(S=F.createElement("path",{fill:"#44d860",fillRule:"evenodd",d:"M375.24 427.205a3.318 3.318 0 1 0 0-6.635 3 3 0 0 0-.423.042q-.038-.15-.077-.298a3.319 3.319 0 0 0-1.278-6.38 3.28 3.28 0 0 0-2.001.688q-.11-.113-.223-.223a3.3 3.3 0 0 0 .671-1.983 3.318 3.318 0 0 0-6.37-1.299 13.27 13.27 0 1 0 0 25.541 3.318 3.318 0 0 0 6.37-1.3 3.3 3.3 0 0 0-.671-1.982q.113-.11.223-.223a3.28 3.28 0 0 0 2.001.688 3.318 3.318 0 0 0 1.278-6.38c.028-.098.05-.199.077-.298a3 3 0 0 0 .423.042"})),z||(z=F.createElement("path",{fillRule:"evenodd",d:"M388.511 329.334a3.6 3.6 0 0 1-.65-.067 3.3 3.3 0 0 1-.624-.185 3.5 3.5 0 0 1-.572-.306 5 5 0 0 1-.504-.411 4 4 0 0 1-.41-.504 3.28 3.28 0 0 1-.558-1.845 3.6 3.6 0 0 1 .067-.65 4 4 0 0 1 .184-.624 3.5 3.5 0 0 1 .307-.57 3.2 3.2 0 0 1 .914-.916 3.5 3.5 0 0 1 .572-.305 3.3 3.3 0 0 1 .624-.186 3.1 3.1 0 0 1 1.3 0 3.2 3.2 0 0 1 1.195.49 5 5 0 0 1 .504.412 5 5 0 0 1 .411.504 3.4 3.4 0 0 1 .306.571 3.5 3.5 0 0 1 .252 1.274 3.36 3.36 0 0 1-.969 2.349 5 5 0 0 1-.504.411 3.3 3.3 0 0 1-1.845.558m26.542-1.66a3.4 3.4 0 0 1-2.35-.968 5 5 0 0 1-.41-.504 3.28 3.28 0 0 1-.558-1.845 3.39 3.39 0 0 1 .967-2.349 5 5 0 0 1 .505-.411 3.5 3.5 0 0 1 .572-.305 3.3 3.3 0 0 1 .623-.186 3.1 3.1 0 0 1 1.3 0 3.2 3.2 0 0 1 1.195.49 5 5 0 0 1 .504.412 3.4 3.4 0 0 1 .97 2.35 4 4 0 0 1-.067.65 3.4 3.4 0 0 1-.186.623 5 5 0 0 1-.305.57 5 5 0 0 1-.412.505 5 5 0 0 1-.504.412 3.3 3.3 0 0 1-1.844.557"})))}},4706:(e,a,t)=>{t.r(a),t.d(a,{default:()=>M});var r=t(4164),l=t(8774),n=t(4586),c=t(3277),h=t(1107);const d={features:"features_t9lD",featureSvg:"featureSvg_GfXr"};var m=t(856);function i(){for(var e=arguments.length,a=new Array(e),t=0;t(0,s.jsx)(f,{...e},a)))})})})}var E=t(6932),p=t(6540),x=t(7859);const v=(0,t(6990).F)("inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50",{variants:{variant:{default:"bg-primary text-primary-foreground hover:bg-primary/90",destructive:"bg-destructive text-destructive-foreground hover:bg-destructive/90",outline:"border border-input bg-background hover:bg-accent hover:text-accent-foreground",secondary:"bg-secondary text-secondary-foreground hover:bg-secondary/80",ghost:"hover:bg-accent hover:text-accent-foreground",link:"text-primary underline-offset-4 hover:underline"},size:{default:"h-10 px-4 py-2",sm:"h-9 rounded-md px-3",lg:"h-11 rounded-md px-8",icon:"h-10 w-10"}},defaultVariants:{variant:"default",size:"default"}}),R=p.forwardRef(((e,a)=>{let{className:t,variant:r,size:l,asChild:n=!1,...c}=e;const h=n?x.DX:"button";return(0,s.jsx)(h,{className:i(v({variant:r,size:l,className:t})),ref:a,...c})}));function w(e){let{demo:a=!1,onAcceptCallback:t=()=>{},onDeclineCallback:r=()=>{}}=e;const[l,n]=(0,p.useState)(!1),[c,h]=(0,p.useState)(!1);return(0,p.useEffect)((()=>{try{n(!0),document.cookie.includes("cookieConsent=true")&&(a||(n(!1),setTimeout((()=>{h(!0)}),700)))}catch(e){}}),[]),(0,s.jsx)("div",{className:i("fixed z-[200] bottom-0 left-0 right-0 sm:left-4 sm:bottom-4 w-full sm:max-w-md transition-transform duration-700",l?"transition-[opacity,transform] translate-y-0 opacity-100":"transition-[opacity,transform] translate-y-8 opacity-0",c&&"hidden"),children:(0,s.jsx)("div",{className:"bg-secondary rounded-md m-2",children:(0,s.jsxs)("div",{className:"grid gap-2",children:[(0,s.jsxs)("div",{className:"border-b border-border h-14 flex items-center justify-between p-4",children:[(0,s.jsx)("h1",{className:"text-lg font-medium",children:"We use cookies and TOS"}),(0,s.jsx)(E.A,{className:"h-[1.2rem] w-[1.2rem]"})]}),(0,s.jsx)("div",{className:"p-4",children:(0,s.jsxs)("p",{className:"text-sm font-normal",children:["We use cookies to ensure you get the best experience on our website. For more information on how we use cookies, please see our cookie policy.",(0,s.jsx)("br",{}),(0,s.jsx)("br",{}),(0,s.jsxs)("span",{className:"text-xs",children:['By clicking "',(0,s.jsx)("span",{className:"font-medium opacity-80",children:"Accept"}),'", you agree to our use of cookies and the TOS.']}),(0,s.jsx)("br",{}),(0,s.jsx)("a",{href:"https://raw.githubusercontent.com/open-wa/wa-automate-nodejs/master/tos.md",className:"text-xs underline",children:"Learn more."})]})}),(0,s.jsxs)("div",{className:"flex gap-2 p-4 py-5 border-t border-border bg-background/20",children:[(0,s.jsx)(R,{onClick:()=>{n(!1),document.cookie="cookieConsent=true; expires=Fri, 31 Dec 9999 23:59:59 GMT",setTimeout((()=>{h(!0)}),700),t()},className:"w-full",children:"Accept"}),(0,s.jsx)(R,{onClick:()=>{window.posthog&&window.posthog.opt_out_capturing().setIsOpen(!1),setTimeout((()=>{h(!0)}),700),r()},className:"w-full",variant:"secondary",children:"Decline"})]})]})})})}R.displayName="Button";const u={heroBanner:"heroBanner_qdFl",buttons:"buttons_AeoN"};function y(){const{siteConfig:e}=(0,n.A)();return(0,s.jsx)("header",{className:(0,r.A)("hero hero--primary",u.heroBanner),children:(0,s.jsxs)("div",{className:"container",children:[(0,s.jsx)(h.A,{as:"h1",className:"hero__title",children:e.title}),(0,s.jsx)("p",{className:"hero__subtitle",children:e.tagline}),(0,s.jsx)("div",{className:u.buttons,children:(0,s.jsx)(l.A,{className:"button button--secondary button--lg",to:"/docs/intro",children:"Docusaurus Tutorial - 5min \u23f1\ufe0f"})})]})})}function M(){const{siteConfig:e}=(0,n.A)();return(0,s.jsxs)(c.A,{title:`Hello from ${e.title}`,description:"Description will go into a meta tag in ",children:[(0,s.jsx)(w,{}),(0,s.jsx)(y,{}),(0,s.jsx)("main",{children:(0,s.jsx)(g,{})})]})}}}]); \ No newline at end of file diff --git a/assets/js/1e4232ab.140fec84.js b/assets/js/1e4232ab.140fec84.js deleted file mode 100644 index 3b67ba5e86..0000000000 --- a/assets/js/1e4232ab.140fec84.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1953],{3976:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=s(4848),r=s(8453);const o={sidebar_position:2},a="Create a Document",i={id:"tutorial-basics/create-a-document",title:"Create a Document",description:"Documents are groups of pages connected through:",source:"@site/docs/tutorial-basics/create-a-document.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-document",permalink:"/docs/tutorial-basics/create-a-document",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Create a Page",permalink:"/docs/tutorial-basics/create-a-page"},next:{title:"Create a Blog Post",permalink:"/docs/tutorial-basics/create-a-blog-post"}},c={},l=[{value:"Create your first Doc",id:"create-your-first-doc",level:2},{value:"Configure the Sidebar",id:"configure-the-sidebar",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"create-a-document",children:"Create a Document"}),"\n",(0,n.jsxs)(t.p,{children:["Documents are ",(0,n.jsx)(t.strong,{children:"groups of pages"})," connected through:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["a ",(0,n.jsx)(t.strong,{children:"sidebar"})]}),"\n",(0,n.jsx)(t.li,{children:(0,n.jsx)(t.strong,{children:"previous/next navigation"})}),"\n",(0,n.jsx)(t.li,{children:(0,n.jsx)(t.strong,{children:"versioning"})}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"create-your-first-doc",children:"Create your first Doc"}),"\n",(0,n.jsxs)(t.p,{children:["Create a Markdown file at ",(0,n.jsx)(t.code,{children:"docs/hello.md"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-md",metastring:'title="docs/hello.md"',children:"# Hello\n\nThis is my **first Docusaurus document**!\n"})}),"\n",(0,n.jsxs)(t.p,{children:["A new document is now available at ",(0,n.jsx)(t.a,{href:"http://localhost:3000/docs/hello",children:"http://localhost:3000/docs/hello"}),"."]}),"\n",(0,n.jsx)(t.h2,{id:"configure-the-sidebar",children:"Configure the Sidebar"}),"\n",(0,n.jsxs)(t.p,{children:["Docusaurus automatically ",(0,n.jsx)(t.strong,{children:"creates a sidebar"})," from the ",(0,n.jsx)(t.code,{children:"docs"})," folder."]}),"\n",(0,n.jsx)(t.p,{children:"Add metadata to customize the sidebar label and position:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-md",metastring:'title="docs/hello.md" {1-4}',children:"---\nsidebar_label: 'Hi!'\nsidebar_position: 3\n---\n\n# Hello\n\nThis is my **first Docusaurus document**!\n"})}),"\n",(0,n.jsxs)(t.p,{children:["It is also possible to create your sidebar explicitly in ",(0,n.jsx)(t.code,{children:"sidebars.js"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-js",metastring:'title="sidebars.js"',children:"export default {\n tutorialSidebar: [\n 'intro',\n // highlight-next-line\n 'hello',\n {\n type: 'category',\n label: 'Tutorial',\n items: ['tutorial-basics/create-a-document'],\n },\n ],\n};\n"})})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>i});var n=s(6540);const r={},o=n.createContext(r);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1e4232ab.b0295233.js b/assets/js/1e4232ab.b0295233.js new file mode 100644 index 0000000000..197e40152f --- /dev/null +++ b/assets/js/1e4232ab.b0295233.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1953],{3976:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=s(4848),r=s(8453);const o={sidebar_position:2},a="Create a Document",i={id:"tutorial-basics/create-a-document",title:"Create a Document",description:"Documents are groups of pages connected through:",source:"@site/docs/tutorial-basics/create-a-document.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-document",permalink:"/docs/tutorial-basics/create-a-document",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Create a Page",permalink:"/docs/tutorial-basics/create-a-page"},next:{title:"Create a Blog Post",permalink:"/docs/tutorial-basics/create-a-blog-post"}},c={},l=[{value:"Create your first Doc",id:"create-your-first-doc",level:2},{value:"Configure the Sidebar",id:"configure-the-sidebar",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"create-a-document",children:"Create a Document"})}),"\n",(0,n.jsxs)(t.p,{children:["Documents are ",(0,n.jsx)(t.strong,{children:"groups of pages"})," connected through:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["a ",(0,n.jsx)(t.strong,{children:"sidebar"})]}),"\n",(0,n.jsx)(t.li,{children:(0,n.jsx)(t.strong,{children:"previous/next navigation"})}),"\n",(0,n.jsx)(t.li,{children:(0,n.jsx)(t.strong,{children:"versioning"})}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"create-your-first-doc",children:"Create your first Doc"}),"\n",(0,n.jsxs)(t.p,{children:["Create a Markdown file at ",(0,n.jsx)(t.code,{children:"docs/hello.md"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-md",metastring:'title="docs/hello.md"',children:"# Hello\n\nThis is my **first Docusaurus document**!\n"})}),"\n",(0,n.jsxs)(t.p,{children:["A new document is now available at ",(0,n.jsx)(t.a,{href:"http://localhost:3000/docs/hello",children:"http://localhost:3000/docs/hello"}),"."]}),"\n",(0,n.jsx)(t.h2,{id:"configure-the-sidebar",children:"Configure the Sidebar"}),"\n",(0,n.jsxs)(t.p,{children:["Docusaurus automatically ",(0,n.jsx)(t.strong,{children:"creates a sidebar"})," from the ",(0,n.jsx)(t.code,{children:"docs"})," folder."]}),"\n",(0,n.jsx)(t.p,{children:"Add metadata to customize the sidebar label and position:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-md",metastring:'title="docs/hello.md" {1-4}',children:"---\nsidebar_label: 'Hi!'\nsidebar_position: 3\n---\n\n# Hello\n\nThis is my **first Docusaurus document**!\n"})}),"\n",(0,n.jsxs)(t.p,{children:["It is also possible to create your sidebar explicitly in ",(0,n.jsx)(t.code,{children:"sidebars.js"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-js",metastring:'title="sidebars.js"',children:"export default {\n tutorialSidebar: [\n 'intro',\n // highlight-next-line\n 'hello',\n {\n type: 'category',\n label: 'Tutorial',\n items: ['tutorial-basics/create-a-document'],\n },\n ],\n};\n"})})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>i});var n=s(6540);const r={},o=n.createContext(r);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f391b9e.c8f48283.js b/assets/js/1f391b9e.c8f48283.js new file mode 100644 index 0000000000..ceec97faad --- /dev/null +++ b/assets/js/1f391b9e.c8f48283.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6061],{2234:(e,n,t)=>{t.d(n,{A:()=>o});t(6540);var i=t(4164),a=t(4084),s=t(7559),r=t(890),l=t(4848);function c(e){let{className:n}=e;return(0,l.jsx)(r.A,{type:"caution",title:(0,l.jsx)(a.Rc,{}),className:(0,i.A)(n,s.G.common.unlistedBanner),children:(0,l.jsx)(a.Uh,{})})}function o(e){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(a.AE,{}),(0,l.jsx)(c,{...e})]})}},1689:(e,n,t)=>{t.d(n,{A:()=>d});t(6540);var i=t(4164),a=t(4084),s=t(7559),r=t(890),l=t(4848);function c(e){let{className:n}=e;return(0,l.jsx)(r.A,{type:"caution",title:(0,l.jsx)(a.Yh,{}),className:(0,i.A)(n,s.G.common.draftBanner),children:(0,l.jsx)(a.TT,{})})}var o=t(2234);function d(e){let{metadata:n}=e;const{unlisted:t,frontMatter:i}=n;return(0,l.jsxs)(l.Fragment,{children:[(t||i.unlisted)&&(0,l.jsx)(o.A,{}),i.draft&&(0,l.jsx)(c,{})]})}},7973:(e,n,t)=>{t.r(n),t.d(n,{default:()=>f});t(6540);var i=t(4164),a=t(5500),s=t(7559),r=t(3277),l=t(8509),c=t(7763),o=t(1689),d=t(4336);const m={mdxPageWrapper:"mdxPageWrapper_j9I6"};var u=t(4848);function f(e){const{content:n}=e,{metadata:t,assets:f}=n,{title:h,editUrl:v,description:x,frontMatter:g,lastUpdatedBy:p,lastUpdatedAt:A}=t,{keywords:j,wrapperClassName:b,hide_table_of_contents:L}=g,N=f.image??g.image,C=!!(v||A||p);return(0,u.jsx)(a.e3,{className:(0,i.A)(b??s.G.wrapper.mdxPages,s.G.page.mdxPage),children:(0,u.jsxs)(r.A,{children:[(0,u.jsx)(a.be,{title:h,description:x,keywords:j,image:N}),(0,u.jsx)("main",{className:"container container--fluid margin-vert--lg",children:(0,u.jsxs)("div",{className:(0,i.A)("row",m.mdxPageWrapper),children:[(0,u.jsxs)("div",{className:(0,i.A)("col",!L&&"col--8"),children:[(0,u.jsx)(o.A,{metadata:t}),(0,u.jsx)("article",{children:(0,u.jsx)(l.A,{children:(0,u.jsx)(n,{})})}),C&&(0,u.jsx)(d.A,{className:(0,i.A)("margin-top--sm",s.G.pages.pageFooterEditMetaRow),editUrl:v,lastUpdatedAt:A,lastUpdatedBy:p})]}),!L&&n.toc.length>0&&(0,u.jsx)("div",{className:"col col--2",children:(0,u.jsx)(c.A,{toc:n.toc,minHeadingLevel:g.toc_min_heading_level,maxHeadingLevel:g.toc_max_heading_level})})]})})]})})}},7763:(e,n,t)=>{t.d(n,{A:()=>o});t(6540);var i=t(4164),a=t(5195);const s={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var r=t(4848);const l="table-of-contents__link toc-highlight",c="table-of-contents__link--active";function o(e){let{className:n,...t}=e;return(0,r.jsx)("div",{className:(0,i.A)(s.tableOfContents,"thin-scrollbar",n),children:(0,r.jsx)(a.A,{...t,linkClassName:l,linkActiveClassName:c})})}},5195:(e,n,t)=>{t.d(n,{A:()=>v});var i=t(6540),a=t(6342);function s(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),t=Array(7).fill(-1);n.forEach(((e,n)=>{const i=t.slice(2,e.level);e.parentIndex=Math.max(...i),t[e.level]=n}));const i=[];return n.forEach((e=>{const{parentIndex:t,...a}=e;t>=0?n[t].children.push(a):i.push(a)})),i}function r(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:i}=e;return n.flatMap((e=>{const n=r({toc:e.children,minHeadingLevel:t,maxHeadingLevel:i});return function(e){return e.level>=t&&e.level<=i}(e)?[{...e,children:n}]:n}))}function l(e){const n=e.getBoundingClientRect();return n.top===n.bottom?l(e.parentNode):n}function c(e,n){let{anchorTopOffset:t}=n;const i=e.find((e=>l(e).top>=t));if(i){return function(e){return e.top>0&&e.bottom{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,i.useRef)(void 0),t=o();(0,i.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:i,linkActiveClassName:a,minHeadingLevel:s,maxHeadingLevel:r}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(i),l=function(e){let{minHeadingLevel:n,maxHeadingLevel:t}=e;const i=[];for(let a=n;a<=t;a+=1)i.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(i.join()))}({minHeadingLevel:s,maxHeadingLevel:r}),o=c(l,{anchorTopOffset:t.current}),d=e.find((e=>o&&o.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,t])}var m=t(8774),u=t(4848);function f(e){let{toc:n,className:t,linkClassName:i,isChild:a}=e;return n.length?(0,u.jsx)("ul",{className:a?void 0:t,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(m.A,{to:`#${e.id}`,className:i??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(f,{isChild:!0,toc:e.children,className:t,linkClassName:i})]},e.id)))}):null}const h=i.memo(f);function v(e){let{toc:n,className:t="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:o,maxHeadingLevel:m,...f}=e;const v=(0,a.p)(),x=o??v.tableOfContents.minHeadingLevel,g=m??v.tableOfContents.maxHeadingLevel,p=function(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:a}=e;return(0,i.useMemo)((()=>r({toc:s(n),minHeadingLevel:t,maxHeadingLevel:a})),[n,t,a])}({toc:n,minHeadingLevel:x,maxHeadingLevel:g});return d((0,i.useMemo)((()=>{if(l&&c)return{linkClassName:l,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:g}}),[l,c,x,g])),(0,u.jsx)(h,{toc:p,className:t,linkClassName:l,...f})}},4084:(e,n,t)=>{t.d(n,{AE:()=>c,Rc:()=>r,TT:()=>d,Uh:()=>l,Yh:()=>o});t(6540);var i=t(1312),a=t(5260),s=t(4848);function r(){return(0,s.jsx)(i.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function l(){return(0,s.jsx)(i.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function c(){return(0,s.jsx)(a.A,{children:(0,s.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function o(){return(0,s.jsx)(i.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function d(){return(0,s.jsx)(i.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}},4037:(e,n,t)=>{t.d(n,{A:()=>a});t(6540);var i=t(3028);t(4848);const a={...i.A,license:i.A.note}},890:(e,n,t)=>{t.d(n,{A:()=>s});t(6540);var i=t(4741),a=t(4848);function s(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,a.jsx)(i.A,{icon:"\ud83c\udfc5",...e}):(0,a.jsx)(a.Fragment,{children:(0,a.jsx)(i.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/1f391b9e.cc0c791f.js b/assets/js/1f391b9e.cc0c791f.js deleted file mode 100644 index f9c380f0e1..0000000000 --- a/assets/js/1f391b9e.cc0c791f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6061],{7973:(e,n,t)=>{t.r(n),t.d(n,{default:()=>f});t(6540);var a=t(4164),s=t(5500),i=t(7559),l=t(9201),r=t(8509),o=t(7763),c=t(996),d=t(4336);const m={mdxPageWrapper:"mdxPageWrapper_j9I6"};var u=t(4848);function f(e){const{content:n}=e,{metadata:{title:t,editUrl:f,description:v,frontMatter:g,unlisted:h,lastUpdatedBy:x,lastUpdatedAt:p},assets:A}=n,{keywords:j,wrapperClassName:L,hide_table_of_contents:N}=g,C=A.image??g.image,H=!!(f||p||x);return(0,u.jsx)(s.e3,{className:(0,a.A)(L??i.G.wrapper.mdxPages,i.G.page.mdxPage),children:(0,u.jsxs)(l.A,{children:[(0,u.jsx)(s.be,{title:t,description:v,keywords:j,image:C}),(0,u.jsx)("main",{className:"container container--fluid margin-vert--lg",children:(0,u.jsxs)("div",{className:(0,a.A)("row",m.mdxPageWrapper),children:[(0,u.jsxs)("div",{className:(0,a.A)("col",!N&&"col--8"),children:[h&&(0,u.jsx)(c.A,{}),(0,u.jsx)("article",{children:(0,u.jsx)(r.A,{children:(0,u.jsx)(n,{})})}),H&&(0,u.jsx)(d.A,{className:(0,a.A)("margin-top--sm",i.G.pages.pageFooterEditMetaRow),editUrl:f,lastUpdatedAt:p,lastUpdatedBy:x})]}),!N&&n.toc.length>0&&(0,u.jsx)("div",{className:"col col--2",children:(0,u.jsx)(o.A,{toc:n.toc,minHeadingLevel:g.toc_min_heading_level,maxHeadingLevel:g.toc_max_heading_level})})]})})]})})}},7763:(e,n,t)=>{t.d(n,{A:()=>c});t(6540);var a=t(4164),s=t(5195);const i={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var l=t(4848);const r="table-of-contents__link toc-highlight",o="table-of-contents__link--active";function c(e){let{className:n,...t}=e;return(0,l.jsx)("div",{className:(0,a.A)(i.tableOfContents,"thin-scrollbar",n),children:(0,l.jsx)(s.A,{...t,linkClassName:r,linkActiveClassName:o})})}},5195:(e,n,t)=>{t.d(n,{A:()=>g});var a=t(6540),s=t(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),t=Array(7).fill(-1);n.forEach(((e,n)=>{const a=t.slice(2,e.level);e.parentIndex=Math.max(...a),t[e.level]=n}));const a=[];return n.forEach((e=>{const{parentIndex:t,...s}=e;t>=0?n[t].children.push(s):a.push(s)})),a}function l(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:a}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:t,maxHeadingLevel:a});return function(e){return e.level>=t&&e.level<=a}(e)?[{...e,children:n}]:n}))}function r(e){const n=e.getBoundingClientRect();return n.top===n.bottom?r(e.parentNode):n}function o(e,n){let{anchorTopOffset:t}=n;const a=e.find((e=>r(e).top>=t));if(a){return function(e){return e.top>0&&e.bottom{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,a.useRef)(void 0),t=c();(0,a.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:a,linkActiveClassName:s,minHeadingLevel:i,maxHeadingLevel:l}=e;function r(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(a),r=function(e){let{minHeadingLevel:n,maxHeadingLevel:t}=e;const a=[];for(let s=n;s<=t;s+=1)a.push(`h${s}.anchor`);return Array.from(document.querySelectorAll(a.join()))}({minHeadingLevel:i,maxHeadingLevel:l}),c=o(r,{anchorTopOffset:t.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(s),e.classList.add(s),n.current=e):e.classList.remove(s)}(e,e===d)}))}return document.addEventListener("scroll",r),document.addEventListener("resize",r),r(),()=>{document.removeEventListener("scroll",r),document.removeEventListener("resize",r)}}),[e,t])}var m=t(8774),u=t(4848);function f(e){let{toc:n,className:t,linkClassName:a,isChild:s}=e;return n.length?(0,u.jsx)("ul",{className:s?void 0:t,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(m.A,{to:`#${e.id}`,className:a??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(f,{isChild:!0,toc:e.children,className:t,linkClassName:a})]},e.id)))}):null}const v=a.memo(f);function g(e){let{toc:n,className:t="table-of-contents table-of-contents__left-border",linkClassName:r="table-of-contents__link",linkActiveClassName:o,minHeadingLevel:c,maxHeadingLevel:m,...f}=e;const g=(0,s.p)(),h=c??g.tableOfContents.minHeadingLevel,x=m??g.tableOfContents.maxHeadingLevel,p=function(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:s}=e;return(0,a.useMemo)((()=>l({toc:i(n),minHeadingLevel:t,maxHeadingLevel:s})),[n,t,s])}({toc:n,minHeadingLevel:h,maxHeadingLevel:x});return d((0,a.useMemo)((()=>{if(r&&o)return{linkClassName:r,linkActiveClassName:o,minHeadingLevel:h,maxHeadingLevel:x}}),[r,o,h,x])),(0,u.jsx)(v,{toc:p,className:t,linkClassName:r,...f})}},996:(e,n,t)=>{t.d(n,{A:()=>f});t(6540);var a=t(4164),s=t(1312),i=t(5260),l=t(4848);function r(){return(0,l.jsx)(s.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function o(){return(0,l.jsx)(s.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function c(){return(0,l.jsx)(i.A,{children:(0,l.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}var d=t(7559),m=t(890);function u(e){let{className:n}=e;return(0,l.jsx)(m.A,{type:"caution",title:(0,l.jsx)(r,{}),className:(0,a.A)(n,d.G.common.unlistedBanner),children:(0,l.jsx)(o,{})})}function f(e){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(c,{}),(0,l.jsx)(u,{...e})]})}},4037:(e,n,t)=>{t.d(n,{A:()=>s});t(6540);var a=t(3028);t(4848);const s={...a.A,license:a.A.note}},890:(e,n,t)=>{t.d(n,{A:()=>i});t(6540);var a=t(4741),s=t(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,s.jsx)(a.A,{icon:"\ud83c\udfc5",...e}):(0,s.jsx)(s.Fragment,{children:(0,s.jsx)(a.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/20288d3d.1d244fe2.js b/assets/js/20288d3d.1d244fe2.js deleted file mode 100644 index 7acd2b40ca..0000000000 --- a/assets/js/20288d3d.1d244fe2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[626],{8236:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var r=t(4848),i=t(8453);const a={},c="Interface: Participant",s={id:"reference/api/model/group-metadata/interfaces/Participant",title:"Interface: Participant",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/Participant.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/Participant.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup"},next:{title:"Interface: ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"contact",id:"contact",level:3},{value:"id",id:"id",level:3},{value:"isAdmin",id:"isadmin",level:3},{value:"isSuperAdmin",id:"issuperadmin",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-participant",children:"Interface: Participant"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"contact"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:(0,r.jsx)(n.code,{children:"NonSerializedId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isadmin",children:"isAdmin"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isAdmin"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issuperadmin",children:"isSuperAdmin"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSuperAdmin"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var r=t(6540);const i={},a=r.createContext(i);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20288d3d.3673aca5.js b/assets/js/20288d3d.3673aca5.js new file mode 100644 index 0000000000..a360081941 --- /dev/null +++ b/assets/js/20288d3d.3673aca5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[626],{8236:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var r=t(4848),i=t(8453);const a={},c="Interface: Participant",s={id:"reference/api/model/group-metadata/interfaces/Participant",title:"Interface: Participant",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/Participant.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/Participant.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup"},next:{title:"Interface: ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"contact",id:"contact",level:3},{value:"id",id:"id",level:3},{value:"isAdmin",id:"isadmin",level:3},{value:"isSuperAdmin",id:"issuperadmin",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-participant",children:"Interface: Participant"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"contact"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:(0,r.jsx)(n.code,{children:"NonSerializedId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isadmin",children:"isAdmin"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isAdmin"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issuperadmin",children:"isSuperAdmin"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSuperAdmin"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var r=t(6540);const i={},a=r.createContext(i);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20fe70bf.066c99b3.js b/assets/js/20fe70bf.066c99b3.js deleted file mode 100644 index f3bcfd52d6..0000000000 --- a/assets/js/20fe70bf.066c99b3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[843],{4158:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(4848),s=n(8453);const i={},r="Decrypting Media",o={id:"how-to/decrypt-media",title:"Decrypting Media",description:"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.",source:"@site/docs/how-to/decrypt-media.md",sourceDirName:"how-to",slug:"/how-to/decrypt-media",permalink:"/docs/how-to/decrypt-media",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/decrypt-media.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Creating an API",permalink:"/docs/how-to/create-api"},next:{title:"Detecting Logouts",permalink:"/docs/how-to/detect-logout"}},c={},d=[{value:"404'd",id:"404d",level:2},{value:"Decrypting Stickers",id:"decrypting-stickers",level:2}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"decrypting-media",children:"Decrypting Media"}),"\n",(0,a.jsx)(t.p,{children:"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { create, Client, decryptMedia } from '@open-wa/wa-automate';\nconst mime = require('mime-types');\nconst fs = require('fs');\n\nfunction start(client: Client) {\n client.onMessage(async message => {\n if (message.mimetype) {\n const filename = `${message.t}.${mime.extension(message.mimetype)}`;\n const mediaData = await decryptMedia(message);\n const imageBase64 = `data:${message.mimetype};base64,${mediaData.toString(\n 'base64'\n )}`;\n await client.sendImage(\n message.from,\n imageBase64,\n filename,\n `You just sent me this ${message.type}`\n );\n fs.writeFile(filename, mediaData, function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n }\n });\n}\n\ncreate().then(client => start(client));\n"})}),"\n",(0,a.jsx)(t.h2,{id:"404d",children:"404'd"}),"\n",(0,a.jsxs)(t.p,{children:["You may sometimes get a ",(0,a.jsx)(t.code,{children:"404"})," error when trying to decrypt media from an old message, this is because media is only available on the main servers for a limited period of time. In these circumstances, you will need to force the host account to reupload media. You can do this by using [[forceStaleMediaUpdate]] then using decryptMedia on the response."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:" const mediaData = await decryptMedia(client.forceStaleMediaUpdate(message.id));\n"})}),"\n",(0,a.jsx)(t.h2,{id:"decrypting-stickers",children:"Decrypting Stickers"}),"\n",(0,a.jsxs)(t.p,{children:["Decrypting stickers with the method shown above will result in a blank ",(0,a.jsx)(t.code,{children:".webp"})," file. To decrypt the sticker, use [[getStickerDecryptable]]."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"\n const mediaData = await decryptMedia(client.getStickerDecryptable(message.id));\n //or\n const mediaData = await client.decryptMedia(message.id);\n"})}),"\n",(0,a.jsx)(t.p,{children:"It is always preferable to keep projects smaller than needed so you can now use a lightweight library called wa-decrypt for projects that do not need all of @open-wa/wa-automate."}),"\n",(0,a.jsx)(t.p,{children:"You can install that using:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"> npm i --save wa-decrypt\n"})}),"\n",(0,a.jsx)(t.p,{children:"and import it like so:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { decryptMedia } from 'wa-decrypt';\n"})}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/smashah/wa-decrypt#readme",children:"Learn more about wa-decrypt here"})})]})}function m(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var a=n(6540);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/20fe70bf.4e532bcd.js b/assets/js/20fe70bf.4e532bcd.js new file mode 100644 index 0000000000..cafd3e2c6b --- /dev/null +++ b/assets/js/20fe70bf.4e532bcd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[843],{4158:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(4848),s=n(8453);const i={},r="Decrypting Media",o={id:"how-to/decrypt-media",title:"Decrypting Media",description:"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.",source:"@site/docs/how-to/decrypt-media.md",sourceDirName:"how-to",slug:"/how-to/decrypt-media",permalink:"/docs/how-to/decrypt-media",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/decrypt-media.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Creating an API",permalink:"/docs/how-to/create-api"},next:{title:"Detecting Logouts",permalink:"/docs/how-to/detect-logout"}},c={},d=[{value:"404'd",id:"404d",level:2},{value:"Decrypting Stickers",id:"decrypting-stickers",level:2}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"decrypting-media",children:"Decrypting Media"})}),"\n",(0,a.jsx)(t.p,{children:"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { create, Client, decryptMedia } from '@open-wa/wa-automate';\nconst mime = require('mime-types');\nconst fs = require('fs');\n\nfunction start(client: Client) {\n client.onMessage(async message => {\n if (message.mimetype) {\n const filename = `${message.t}.${mime.extension(message.mimetype)}`;\n const mediaData = await decryptMedia(message);\n const imageBase64 = `data:${message.mimetype};base64,${mediaData.toString(\n 'base64'\n )}`;\n await client.sendImage(\n message.from,\n imageBase64,\n filename,\n `You just sent me this ${message.type}`\n );\n fs.writeFile(filename, mediaData, function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n }\n });\n}\n\ncreate().then(client => start(client));\n"})}),"\n",(0,a.jsx)(t.h2,{id:"404d",children:"404'd"}),"\n",(0,a.jsxs)(t.p,{children:["You may sometimes get a ",(0,a.jsx)(t.code,{children:"404"})," error when trying to decrypt media from an old message, this is because media is only available on the main servers for a limited period of time. In these circumstances, you will need to force the host account to reupload media. You can do this by using [[forceStaleMediaUpdate]] then using decryptMedia on the response."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:" const mediaData = await decryptMedia(client.forceStaleMediaUpdate(message.id));\n"})}),"\n",(0,a.jsx)(t.h2,{id:"decrypting-stickers",children:"Decrypting Stickers"}),"\n",(0,a.jsxs)(t.p,{children:["Decrypting stickers with the method shown above will result in a blank ",(0,a.jsx)(t.code,{children:".webp"})," file. To decrypt the sticker, use [[getStickerDecryptable]]."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"\n const mediaData = await decryptMedia(client.getStickerDecryptable(message.id));\n //or\n const mediaData = await client.decryptMedia(message.id);\n"})}),"\n",(0,a.jsx)(t.p,{children:"It is always preferable to keep projects smaller than needed so you can now use a lightweight library called wa-decrypt for projects that do not need all of @open-wa/wa-automate."}),"\n",(0,a.jsx)(t.p,{children:"You can install that using:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"> npm i --save wa-decrypt\n"})}),"\n",(0,a.jsx)(t.p,{children:"and import it like so:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"import { decryptMedia } from 'wa-decrypt';\n"})}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/smashah/wa-decrypt#readme",children:"Learn more about wa-decrypt here"})})]})}function m(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var a=n(6540);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2237.81eb5be7.js b/assets/js/2237.d04cc86f.js similarity index 94% rename from assets/js/2237.81eb5be7.js rename to assets/js/2237.d04cc86f.js index 4efd9b9430..902297f555 100644 --- a/assets/js/2237.81eb5be7.js +++ b/assets/js/2237.d04cc86f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2237],{3363:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var i=n(4164),o=n(1312),s=n(1107),r=n(4848);function a(e){let{className:t}=e;return(0,r.jsx)("main",{className:(0,i.A)("container margin-vert--xl",t),children:(0,r.jsx)("div",{className:"row",children:(0,r.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,r.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,r.jsx)(o.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,r.jsx)("p",{children:(0,r.jsx)(o.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,r.jsx)("p",{children:(0,r.jsx)(o.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},2237:(e,t,n)=>{n.r(t),n.d(t,{default:()=>d});n(6540);var i=n(1312),o=n(5500),s=n(9201),r=n(3363),a=n(4848);function d(){const e=(0,i.T)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(o.be,{title:e}),(0,a.jsx)(s.A,{children:(0,a.jsx)(r.A,{})})]})}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2237],{3363:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var i=n(4164),o=n(1312),s=n(1107),r=n(4848);function a(e){let{className:t}=e;return(0,r.jsx)("main",{className:(0,i.A)("container margin-vert--xl",t),children:(0,r.jsx)("div",{className:"row",children:(0,r.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,r.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,r.jsx)(o.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,r.jsx)("p",{children:(0,r.jsx)(o.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,r.jsx)("p",{children:(0,r.jsx)(o.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},2237:(e,t,n)=>{n.r(t),n.d(t,{default:()=>d});n(6540);var i=n(1312),o=n(5500),s=n(3277),r=n(3363),a=n(4848);function d(){const e=(0,i.T)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(o.be,{title:e}),(0,a.jsx)(s.A,{children:(0,a.jsx)(r.A,{})})]})}}}]); \ No newline at end of file diff --git a/assets/js/26af37c4.17b0cee8.js b/assets/js/26af37c4.17b0cee8.js new file mode 100644 index 0000000000..1e7c705e49 --- /dev/null +++ b/assets/js/26af37c4.17b0cee8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8745],{8114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var r=n(4848),i=n(8453);const d={},l="Class: Client",c={id:"reference/api/Client/classes/Client",title:"Class: Client",description:"Methods",source:"@site/docs/reference/api/Client/classes/Client.md",sourceDirName:"reference/api/Client/classes",slug:"/reference/api/Client/classes/Client",permalink:"/docs/reference/api/Client/classes/Client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/classes/Client.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/Client",permalink:"/docs/reference/api/Client/"},next:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"}},t={},a=[{value:"Methods",id:"methods",level:2},{value:'B()
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Example",id:"example",level:4},{value:"acceptGroupJoinRequest()",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel()",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant()",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest()",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat()",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject()",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages()",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-1",level:4},{value:"checkNumberStatus()",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts()
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats()",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat()",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock()",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock()",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity()
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup()",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel()
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector()",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct()
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache()",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"after",id:"after",level:5},{value:"after.chats",id:"afterchats",level:5},{value:"after.msgs",id:"aftermsgs",level:5},{value:"before",id:"before",level:5},{value:"before.chats",id:"beforechats",level:5},{value:"before.msgs",id:"beforemsgs",level:5},{value:"cutMsgCache()",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode()",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia()",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus()",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories()
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat()",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage()",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats()",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus()",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory()
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant()",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download()",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials()",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage()",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage()",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct()
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages()",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus()",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate()
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState()",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation()",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages()",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc()",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds()",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats()",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages()",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"getAllCommunities()",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts()",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups()",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels()",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat()",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages()",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages()",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages()",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel()",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"getBlockedIds()",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile()",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts()",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat()",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById()",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts()",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel()",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Label",id:"label",level:4},{value:'getCommonGroups()
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds()",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins()",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo()",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds()",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants()",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState()",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact()",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature()",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures()",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent()",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray()",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins()",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests()",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo()",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink()",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers()",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId()",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber()",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages()",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId()",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged()",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink()",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups()",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps()",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen()",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink()",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType()",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues()",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"onAck",id:"onack",level:5},{value:"onAddedToGroup",id:"onaddedtogroup",level:5},{value:"onAnyMessage",id:"onanymessage",level:5},{value:"onBattery",id:"onbattery",level:5},{value:"onBroadcast",id:"onbroadcast",level:5},{value:"onButton",id:"onbutton",level:5},{value:"onCallState",id:"oncallstate",level:5},{value:"onChatDeleted",id:"onchatdeleted",level:5},{value:"onChatOpened",id:"onchatopened",level:5},{value:"onChatState",id:"onchatstate",level:5},{value:"onContactAdded",id:"oncontactadded",level:5},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:5},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:5},{value:"onGroupChange",id:"ongroupchange",level:5},{value:"onIncomingCall",id:"onincomingcall",level:5},{value:"onLabel",id:"onlabel",level:5},{value:"onLogout",id:"onlogout",level:5},{value:"onMessage",id:"onmessage",level:5},{value:"onMessageDeleted",id:"onmessagedeleted",level:5},{value:"onNewProduct",id:"onnewproduct",level:5},{value:"onOrder",id:"onorder",level:5},{value:"onPlugged",id:"onplugged",level:5},{value:"onPollVote",id:"onpollvote",level:5},{value:"onReaction",id:"onreaction",level:5},{value:"onRemovedFromGroup",id:"onremovedfromgroup",level:5},{value:"onStateChanged",id:"onstatechanged",level:5},{value:"onStory",id:"onstory",level:5},{value:"getMe()",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById()",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo()
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders()",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage()",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray()",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray()
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder()
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage()",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData()",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats()",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer()",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId()",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo()",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty()",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot()",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages()",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus()",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"id",id:"id",level:5},{value:"status",id:"status",level:5},{value:"getStickerDecryptable()",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:"Deprecated",id:"deprecated-1",level:4},{value:'getStoryViewers()
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode()",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages()",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages()",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards()",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion()",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward()",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck()",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin()",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo()",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted()",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline()",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected()",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe()
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected()",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink()",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta()",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill()",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup()",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks()",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages()",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat()",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages()",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate()",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger()",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout()",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead()",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread()",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics()",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware()",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat()
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct()
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder()
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat()",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus()
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus()
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postThumbnailStatus()
restricted
',id:"postthumbnailstatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:'postVideoStatus()
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"prepEventData()",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"promoteParticipant()",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"react()",id:"react",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-152",level:4},{value:"refresh()",id:"refresh",level:3},{value:"Returns",id:"returns-153",level:4},{value:"registerWebhook()",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"rejectGroupJoinRequest()",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-155",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-156",level:4},{value:"removeLabel()",id:"removelabel",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeParticipant()",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeProduct()",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"removeWebhook()",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:"Retruns",id:"retruns",level:4},{value:"reply()",id:"reply",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:'reportSpam()
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"resizePage()",id:"resizepage",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"revokeGroupInviteLink()",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAdvancedButtons()",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"Deprecated",id:"deprecated-2",level:4},{value:"sendAudio()",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendBanner()",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendButtons()",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"sendContact()",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendCustomProduct()",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"sendEmoji()",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFile()",id:"sendfile",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendFileFromUrl()",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphy()",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendGiphyAsSticker()",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImage()",id:"sendimage",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:"sendImageAsSticker()",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:'sendImageAsStickerAsReply()
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendImageWithProduct()",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendLinkWithAutoPreview()",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendListMessage()",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"sendLocation()",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMessageWithThumb()",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:"sendMp4AsSticker()",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:'sendMultipleContacts()
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPaymentRequest()",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:"sendPoll()",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:'sendProduct()
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendPtt()",id:"sendptt",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:"sendRawWebpAsSticker()",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:'sendRawWebpAsStickerAsReply()
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendReplyWithMentions()",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendSeen()",id:"sendseen",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:"sendStickerfromUrl()",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendStickerfromUrlAsReply()
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:'sendText()
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendTextWithMentions()",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVCard()",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendVideoAsGif()",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:"sendYoutubeLink()",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatBackgroundColourHex()
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:'setChatEphemeral()
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setChatState()",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupApprovalMode()",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupDescription()",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupEditToAdminsOnly()",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIcon()",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:"setGroupIconByUrl()",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:'setGroupTitle()
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setGroupToAdminsOnly()",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyName()",id:"setmyname",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setMyStatus()",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setPresence()",id:"setpresence",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"setProfilePic()",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateRecording()",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"simulateTyping()",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"starMessage()",id:"starmessage",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-218",level:4},{value:"syncContacts()",id:"synccontacts",level:3},{value:"Returns",id:"returns-219",level:4},{value:'tagEveryone()
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"Mention",id:"mention",level:4},{value:"Default",id:"default",level:4},{value:"testButtons()",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"testCallback()",id:"testcallback",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:'unmuteChat()
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"unstarMessage()",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"updateWebhook()",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-225",level:4},{value:"waitAllQEmpty()",id:"waitallqempty",level:3},{value:"Returns",id:"returns-226",level:4},{value:"waitWhQIdle()",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-227",level:4},{value:"Events",id:"events",level:2},{value:"onAck()",id:"onack-1",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAddedToGroup()",id:"onaddedtogroup-1",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onAnyMessage()",id:"onanymessage-1",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"Fires",id:"fires",level:4},{value:"onBattery()",id:"onbattery-1",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"Deprecated",id:"deprecated-7",level:4},{value:"Fires",id:"fires-1",level:4},{value:"onBroadcast()",id:"onbroadcast-1",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"Fires",id:"fires-2",level:4},{value:"onButton()",id:"onbutton-1",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"Fires",id:"fires-3",level:4},{value:"onCallState()",id:"oncallstate-1",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:"onChatDeleted()",id:"onchatdeleted-1",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:"Fires",id:"fires-4",level:4},{value:'onChatOpened()
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onChatState()
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"Fires",id:"fires-5",level:4},{value:'onContactAdded()
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGlobalParticipantsChanged()",id:"onglobalparticipantschanged-1",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupApprovalRequest()",id:"ongroupapprovalrequest-1",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onGroupChange()",id:"ongroupchange-1",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onIncomingCall()",id:"onincomingcall-1",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLabel()",id:"onlabel-1",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"Fires",id:"fires-6",level:4},{value:"onLiveLocation()",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"Emits",id:"emits",level:4},{value:"onLogout()",id:"onlogout-1",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"Fires",id:"fires-7",level:4},{value:"onMessage()",id:"onmessage-1",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"Fires",id:"fires-8",level:4},{value:"onMessageDeleted()",id:"onmessagedeleted-1",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"Fires",id:"fires-9",level:4},{value:"onParticipantsChanged()",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPlugged()",id:"onplugged-1",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:"Fires",id:"fires-10",level:4},{value:"onPollVote()",id:"onpollvote-1",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:"Fires",id:"fires-11",level:4},{value:'onReaction()
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"Fires",id:"fires-12",level:4},{value:'onRemovedFromGroup()
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:"onStateChanged()",id:"onstatechanged-1",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4},{value:"Fires",id:"fires-13",level:4},{value:'onStory()
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-202",level:4},{value:"Returns",id:"returns-254",level:4},{value:"Fires",id:"fires-14",level:4}];function o(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"class-client",children:"Class: Client"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsxs)(s.h3,{id:"b-insiders",children:["B() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"B"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"payload"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Use a raw payload within your open-wa session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"payload"})]}),"\n",(0,r.jsx)(s.p,{children:"returns: MessageId"}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(s.p,{children:"If there is a code block, then both TypeDoc and VSCode will treat\ntext outside of the code block as regular text."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"await B('44123456789@c.us', {\n test: 1\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client#loadallearliermessages",children:"loadAllEarlierMessages"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"acceptgroupjoinrequest",children:"acceptGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"acceptGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Accepts a request from a recipient to join a group. Takes the message ID of the request message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addlabel",children:"addLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addparticipant",children:"addParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Add participant to Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the contacts, returns ",(0,r.jsx)(s.code,{children:"NOT_A_CONTACT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"approvegroupjoinrequest",children:"approveGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"approveGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Approves a group join request"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"archivechat",children:"archiveChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"archiveChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"archive"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"archive"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean true => archive, false => unarchive"}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked, false: didnt work (probably already in desired state)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"autoreject",children:"autoReject()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"autoReject"}),"(",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."}),"\n",(0,r.jsx)(s.p,{children:"Update: Due to the nature of MD, the host account will continue ringing."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional message to send to the calling account when their call is detected and rejected"}),"\n",(0,r.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"awaitmessages",children:"awaitMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"awaitMessages"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[FROM DISCORDJS]\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"The filter function to use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,r.jsx)(s.code,{children:"AwaitMessagesOptions"})})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsx)(s.p,{children:"Optional options to pass to the internal collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n",(0,r.jsx)(s.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"checknumberstatus",children:"checkNumberStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkNumberStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a number is a valid WA number"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"checkreadreceipts-insiders",children:["checkReadReceipts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkReadReceipts"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Check if a recipient has read receipts on."}),"\n",(0,r.jsx)(s.p,{children:"This will only work if you have chats sent back and forth between you and the contact 1-1."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Id of the contact with which you have an existing conversation with messages already."}),"\n",(0,r.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearallchats",children:"clearAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearAllChats"}),"(",(0,r.jsx)(s.code,{children:"ts"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ts?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number A chat that has had a message after ts (epoch timestamp) will not be cleared."}),"\n",(0,r.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearchat",children:"clearChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete all messages from the chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactblock",children:"contactBlock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactBlock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Block contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactunblock",children:"contactUnblock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactUnblock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unblock contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createcommunity-insiders",children:["createCommunity() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createCommunity"}),"(",(0,r.jsx)(s.code,{children:"communityName"}),", ",(0,r.jsx)(s.code,{children:"communitySubject"}),", ",(0,r.jsx)(s.code,{children:"icon"}),", ",(0,r.jsx)(s.code,{children:"existingGroups"}),", ",(0,r.jsx)(s.code,{children:"newGroups"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Create a new community"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The community name"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communitySubject"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"icon"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"DataURL of a 1:1 ratio jpeg for the community icon"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"existingGroups"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[] = ",(0,r.jsx)(s.code,{children:"[]"})]}),"\n",(0,r.jsx)(s.p,{children:"An array of existing group IDs, that are not already part of a community, to add to this new community."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newGroups?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:(0,r.jsx)(s.code,{children:"NewCommunityGroup"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of new group objects that"}),"\n",(0,r.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"creategroup",children:"createGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createGroup"}),"(",(0,r.jsx)(s.code,{children:"groupName"}),", ",(0,r.jsx)(s.code,{children:"contacts"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a group and add contacts to it"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"group name: 'New group'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contacts"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createlabel-insiders",children:["createLabel() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.jsx)(s.code,{children:'"58"'}),")"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"createmessagecollector",children:"createMessageCollector()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createMessageCollector"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"): ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a new message collector for the chat which is related to the first parameter c"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,r.jsx)(s.code,{children:"CollectorOptions"})})]}),"\n",(0,r.jsx)(s.p,{children:"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc."}),"\n",(0,r.jsx)(s.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createnewproduct-insiders",children:["createNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createNewProduct"}),"(",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"price"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"images"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Add a product to your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutchatcache",children:"cutChatCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutChatCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-19",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"after",children:"after"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"after"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"afterchats",children:"after.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"aftermsgs",children:"after.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"before",children:"before"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"before"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforechats",children:"before.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforemsgs",children:"before.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutmsgcache",children:"cutMsgCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutMsgCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-20",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"darkmode",children:"darkMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"darkMode"}),"(",(0,r.jsx)(s.code,{children:"activate"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Start dark mode [NOW GENERALLY AVAILABLE]"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"activate"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to activate dark mode, false to deactivate"}),"\n",(0,r.jsx)(s.h4,{id:"returns-21",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"decryptmedia",children:"decryptMedia()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"decryptMedia"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Decrypts a media message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.p,{children:"This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID."}),"\n",(0,r.jsx)(s.h4,{id:"returns-22",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise<[[DataURL]]>"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deleteallstatus",children:"deleteAllStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStatus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-23",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deleteallstories-restricted",children:["deleteAllStories() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStories"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Deletes all your existing stories."}),"\n",(0,r.jsx)(s.h4,{id:"returns-24",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletechat",children:"deleteChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete the conversation from your WA"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-25",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletemessage",children:"deleteMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"onlyLocal"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Deletes message of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat id from which to delete the message."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The specific message id of the message to be deleted"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyLocal"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false."}),"\n",(0,r.jsx)(s.h4,{id:"returns-26",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"nothing"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestalechats",children:"deleteStaleChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStaleChats"}),"(",(0,r.jsx)(s.code,{children:"startingFrom"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.jsx)(s.code,{children:"100"})," then all chats from index ",(0,r.jsx)(s.code,{children:"100"})," onwards will be deleted."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"startingFrom?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.jsx)(s.code,{children:"1000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-27",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestatus",children:"deleteStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStatus"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-28",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deletestory-restricted",children:["deleteStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStory"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Consumes a list of id strings of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"string [] | string an array of ids of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"returns-29",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"demoteparticipant",children:"demoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"demoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Demote Admin of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-30",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"download",children:"download()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"download"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"optionsOverride"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A convinience method to download the [[DataURL]] of a file"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"optionsOverride"}),": ",(0,r.jsx)(s.code,{children:"any"})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:["You can use this to override the ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"axios request config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-31",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadfilewithcredentials",children:"downloadFileWithCredentials()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadFileWithCredentials"}),"(",(0,r.jsx)(s.code,{children:"url"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download via the browsers authenticated session via URL."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-32",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"base64 string (non-data url)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadprofilepicfrommessage",children:"downloadProfilePicFromMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadProfilePicFromMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download profile pics from the message object."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-33",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"editmessage",children:"editMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"text"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"NOTE: This is experimental, most accounts do not have access to this feature in their apps."}),"\n",(0,r.jsx)(s.p,{children:"Edit an existing message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message ID to edit"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The new text content"}),"\n",(0,r.jsx)(s.h4,{id:"returns-34",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"editproduct-insiders",children:["editProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),", ",(0,r.jsx)(s.code,{children:"name"}),"?, ",(0,r.jsx)(s.code,{children:"price"}),"?, ",(0,r.jsx)(s.code,{children:"currency"}),"?, ",(0,r.jsx)(s.code,{children:"images"}),"?, ",(0,r.jsx)(s.code,{children:"description"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Edit a product in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The catalog ID of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-35",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"emitunreadmessages",children:"emitUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"emitUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."}),"\n",(0,r.jsx)(s.h4,{id:"returns-36",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of message IDs"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forcerefocus",children:"forceRefocus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceRefocus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is a convinient method to click the ",(0,r.jsx)(s.code,{children:"Use Here"})," button in the WA web session."]}),"\n",(0,r.jsxs)(s.p,{children:["Use this when [[STATE]] is ",(0,r.jsx)(s.code,{children:"CONFLICT"}),". You can read more about managing state here:"]}),"\n",(0,r.jsx)(s.p,{children:"[[Detecting Logouts]]"}),"\n",(0,r.jsx)(s.h4,{id:"returns-37",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"forcestalemediaupdate-insiders",children:["forceStaleMediaUpdate() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceStaleMediaUpdate"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."}),"\n",(0,r.jsx)(s.p,{children:"if you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-32",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-38",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["[[Message]] OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdateconnectionstate",children:"forceUpdateConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateConnectionState"}),"(",(0,r.jsx)(s.code,{children:"killBeforeReconnect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forces the session to update the connection state."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"killBeforeReconnect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-39",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"updated connection state"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdatelivelocation",children:"forceUpdateLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Id of the chat you want to force the phone to get the livelocation data for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-40",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," | boolean"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forwardmessages",children:"forwardMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forwardMessages"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messages"}),", ",(0,r.jsx)(s.code,{children:"skipMyMessages"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forward an array of messages to a specific chat using the message ids or Objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messages"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"this can be any mixture of message ids or message objects"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"skipMyMessages"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"This indicates whether or not to skip your own messages from the array"}),"\n",(0,r.jsx)(s.h4,{id:"returns-41",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gc",children:"gc()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"gc"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"It calls the JavaScript garbage collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-42",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Nothing."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatids",children:"getAllChatIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves all Chat Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-43",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [ChatId]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchats",children:"getAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChats"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-44",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatswithmessages",children:(0,r.jsx)(s.del,{children:"getAllChatsWithMessages()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatsWithMessages"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-45",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats with messages"}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.code,{children:"getAllUnreadMessages"})," instead of this to see all messages indicated by the green dots in the chat."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcommunities",children:"getAllCommunities()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllCommunities"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all commmunity Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-46",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of group ids"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcontacts",children:"getAllContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all contacts"}),"\n",(0,r.jsx)(s.h4,{id:"returns-47",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Contact]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallgroups",children:"getAllGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllGroups"}),"(",(0,r.jsx)(s.code,{children:"withNewMessagesOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all groups"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessagesOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-48",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of groups"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getalllabels",children:"getAllLabels()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllLabels"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns all labels and the corresponding tagged items."}),"\n",(0,r.jsx)(s.h4,{id:"returns-49",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallmessagesinchat",children:"getAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all Messages in a chat that have been loaded within the WA web instance."}),"\n",(0,r.jsx)(s.p,{children:"This does not load every single message in the chat history."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-50",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallnewmessages",children:"getAllNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all new Messages. where isNewMsg==true"}),"\n",(0,r.jsx)(s.h4,{id:"returns-51",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallunreadmessages",children:"getAllUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages. where ack==-1"}),"\n",(0,r.jsx)(s.h4,{id:"returns-52",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getamountofloadedmessages",children:"getAmountOfLoadedMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAmountOfLoadedMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."}),"\n",(0,r.jsx)(s.h4,{id:"returns-53",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbatterylevel",children:"getBatteryLevel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBatteryLevel"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves Battery Level"}),"\n",(0,r.jsx)(s.h4,{id:"returns-54",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getblockedids",children:"getBlockedIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBlockedIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves an array of IDs of accounts blocked by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"returns-55",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofile",children:"getBusinessProfile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfile"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the business info of a given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-56",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofilesproducts",children:"getBusinessProfilesProducts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfilesProducts"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Find any product listings of the given number. Use this to query a catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-41",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-57",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchat",children:"getChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChat"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-42",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-58",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatbyid",children:"getChatById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatById"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-59",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatwithnoncontacts",children:"getChatWithNonContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatWithNonContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a list of contact with whom the host number has an existing chat who are also not contacts."}),"\n",(0,r.jsx)(s.h4,{id:"returns-60",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatsbylabel",children:"getChatsByLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatsByLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'}),"\n",(0,r.jsx)(s.p,{children:"This method is case insenstive and only works on business host accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-44",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-61",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.h4,{id:"label",children:"Label"}),"\n",(0,r.jsx)(s.p,{children:"The label name"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getcommongroups-insiders",children:["getCommonGroups() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommonGroups"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the groups that you have in common with a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-45",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-62",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadminids",children:"getCommunityAdminIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdminIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admin Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-46",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-63",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadmins",children:"getCommunityAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdmins"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admins as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-64",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityinfo",children:"getCommunityInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityInfo"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns the community metadata. Like group metadata but with a ",(0,r.jsx)(s.code,{children:"subGroups"})," property which is the group metadata of the community subgroups."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-48",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-65",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipantids",children:"getCommunityParticipantIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipantIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-49",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-66",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipants",children:"getCommunityParticipants()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipants"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-50",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-67",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconfig",children:"getConfig()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConfig"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"}),"\n",(0,r.jsx)(s.h4,{id:"returns-68",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconnectionstate",children:"getConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConnectionState"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the connection state"}),"\n",(0,r.jsx)(s.h4,{id:"returns-69",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcontact",children:"getContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getContact"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves contact detail object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-51",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-70",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"geteventsignature",children:"getEventSignature()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getEventSignature"}),"(",(0,r.jsx)(s.code,{children:"simpleListener"}),"?): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-52",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"simpleListener?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-71",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getfeatures",children:"getFeatures()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getFeatures"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."}),"\n",(0,r.jsx)(s.h4,{id:"returns-72",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgenerateduseragent",children:"getGeneratedUserAgent()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGeneratedUserAgent"}),"(",(0,r.jsx)(s.code,{children:"userA"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the generated user agent, this is so you can send it to the decryption module."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-53",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"userA?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-73",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"String useragent of wa-web session"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgptarray",children:"getGptArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGptArray"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"last"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a properly formatted array of messages from to send to the openai api"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-54",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"last"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"10"})]}),"\n",(0,r.jsx)(s.p,{children:"The amount of previous messages to retrieve. Defaults to 10"}),"\n",(0,r.jsx)(s.h4,{id:"returns-74",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupadmins",children:"getGroupAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupAdmins"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get Admins of a Group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-55",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-75",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupapprovalrequests",children:"getGroupApprovalRequests()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupApprovalRequests"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Gets the contact IDs of members requesting approval to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-76",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinfo",children:"getGroupInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInfo"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the title and description of a given group id."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-77",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinvitelink",children:"getGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an invite link for a group chat. returns false if chat is not a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-78",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembers",children:"getGroupMembers()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembers"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns group members [Contact] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-79",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembersid",children:"getGroupMembersId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembersId"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves group members as [Id] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-80",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gethostnumber",children:"getHostNumber()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getHostNumber"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the host device number. Use this number when registering for a license key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-81",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getindicatednewmessages",children:"getIndicatedNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIndicatedNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n'})}),"\n",(0,r.jsx)(s.h4,{id:"returns-82",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getinstanceid",children:"getInstanceId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getInstanceId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the INSTANCE_ID of the current session"}),"\n",(0,r.jsx)(s.h4,{id:"returns-83",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getisplugged",children:"getIsPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIsPlugged"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves whether or not phone is plugged in (i.e on charge)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-84",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getissuelink",children:"getIssueLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIssueLink"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a pre-filled github issue link to easily report a bug"}),"\n",(0,r.jsx)(s.h4,{id:"returns-85",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getkickedgroups",children:"getKickedGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getKickedGroups"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account has been kicked"}),"\n",(0,r.jsx)(s.h4,{id:"returns-86",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastmsgtimestamps",children:"getLastMsgTimestamps()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastMsgTimestamps"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get an array of chatIds with their respective last message's timestamp."}),"\n",(0,r.jsx)(s.p,{children:"This is useful for determining what chats are old/stale and need to be deleted."}),"\n",(0,r.jsx)(s.h4,{id:"returns-87",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastseen",children:"getLastSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsx)(s.li,{children:"They have set it so you cannot see their last seen via privacy settings."}),"\n",(0,r.jsx)(s.li,{children:"You do not have an existing chat with the contact."}),"\n",(0,r.jsx)(s.li,{children:"The chatId is for a group\nIn both of those instances this method will return undefined."}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat."}),"\n",(0,r.jsx)(s.h4,{id:"returns-88",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"number timestamp when chat was last online or undefined."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicenselink",children:"getLicenseLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseLink"}),"(",(0,r.jsx)(s.code,{children:"params"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a license link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-62",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"params?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-89",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicensetype",children:"getLicenseType()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseType"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the the type of license key used by the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-90",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlistenerqueues",children:"getListenerQueues()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getListenerQueues"}),"(): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have set ",(0,r.jsx)(s.code,{children:"onAnyMessage"})," or ",(0,r.jsx)(s.code,{children:"onMessage"})," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-91",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h5,{id:"onack",children:"onAck"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onaddedtogroup",children:"onAddedToGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onanymessage",children:"onAnyMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbattery",children:"onBattery"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbroadcast",children:"onBroadcast"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbutton",children:"onButton"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncallstate",children:"onCallState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatdeleted",children:"onChatDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatopened",children:"onChatOpened"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatstate",children:"onChatState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncontactadded",children:"onContactAdded"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onglobalparticipantschanged",children:"onGlobalParticipantsChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupapprovalrequest",children:"onGroupApprovalRequest"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupchange",children:"onGroupChange"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onincomingcall",children:"onIncomingCall"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlabel",children:"onLabel"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlogout",children:"onLogout"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessage",children:"onMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessagedeleted",children:"onMessageDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onnewproduct",children:"onNewProduct"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onorder",children:"onOrder"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onplugged",children:"onPlugged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onpollvote",children:"onPollVote"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onreaction",children:"onReaction"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onremovedfromgroup",children:"onRemovedFromGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstory",children:"onStory"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getme",children:"getMe()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMe"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with all of your host device details"}),"\n",(0,r.jsx)(s.h4,{id:"returns-92",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagebyid",children:"getMessageById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageById"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves message object of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-63",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-93",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmessageinfo-insiders",children:["getMessageInfo() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageInfo"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Get the detailed message info for a group message sent out by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-64",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message Id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-94",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagereaders",children:"getMessageReaders()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageReaders"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.jsx)(s.code,{children:"t"})," which represents the time at which that contact read the message."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-65",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-95",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmylastmessage",children:"getMyLastMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyLastMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the last message sent by the host account in any given chat or globally."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"This is optional. If no chat Id is set then the last message sent by the host account will be returned."}),"\n",(0,r.jsx)(s.h4,{id:"returns-96",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object or ",(0,r.jsx)(s.code,{children:"undefined"})," if the host account's last message could not be found."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmystatusarray",children:"getMyStatusArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStatusArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-97",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmystoryarray-restricted",children:["getMyStoryArray() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStoryArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all existing stories."}),"\n",(0,r.jsx)(s.p,{children:"Only works with a Story License Key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-98",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getorder-insiders",children:["getOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getOrder"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an order object"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-99",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"order object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpage",children:"getPage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPage"}),"(): ",(0,r.jsx)(s.code,{children:"Page"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-100",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Page"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpolldata",children:"getPollData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPollData"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns poll data including results and votes."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id of the Poll"}),"\n",(0,r.jsx)(s.h4,{id:"returns-101",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprocessstats",children:"getProcessStats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProcessStats"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the stats of the current process and the corresponding browser process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-102",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprofilepicfromserver",children:"getProfilePicFromServer()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProfilePicFromServer"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat picture"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-69",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-103",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Url of the chat picture or undefined if there is no picture for the chat."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessionid",children:"getSessionId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-104",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessioninfo",children:"getSessionInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionInfo"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the session info"}),"\n",(0,r.jsx)(s.h4,{id:"returns-105",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsingleproperty",children:"getSingleProperty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSingleProperty"}),"(",(0,r.jsx)(s.code,{children:"namespace"}),", ",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"property"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."}),"\n",(0,r.jsx)(s.p,{children:"Example - get message read state (ack):"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-70",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"namespace"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:(0,r.jsx)(s.code,{children:"namespace"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"id of the object to get from the specific namespace"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"property"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the single property key to get from the object."}),"\n",(0,r.jsx)(s.h4,{id:"returns-106",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"any If the property or the id cannot be found, it will return a 404"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsnapshot",children:"getSnapshot()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSnapshot"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?, ",(0,r.jsx)(s.code,{children:"width"}),"?, ",(0,r.jsx)(s.code,{children:"height"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a PNG DataURL screenshot of the session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to open before taking a snapshot"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Width of the viewport for the snapshot. Height also required if you want to resize."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Height of the viewport for the snapshot. Width also required if you want to resize."}),"\n",(0,r.jsx)(s.h4,{id:"returns-107",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstarredmessages",children:"getStarredMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStarredMessages"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the starred messages in a given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to filter starred messages by"}),"\n",(0,r.jsx)(s.h4,{id:"returns-108",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstatus",children:"getStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the status of a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["to '",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-109",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"id",children:"id"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"status",children:"status"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"status"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstickerdecryptable",children:(0,r.jsx)(s.del,{children:"getStickerDecryptable()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStickerDecryptable"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["The message ID ",(0,r.jsx)(s.code,{children:"message.id"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-110",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."}),"\n",(0,r.jsx)(s.p,{children:"If you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getstoryviewers-restricted",children:["getStoryViewers() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStoryViewers"}),"(",(0,r.jsx)(s.code,{children:"id"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an array of user ids that have 'read' your story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-75",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The id of the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-111",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gettunnelcode",children:"getTunnelCode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getTunnelCode"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."}),"\n",(0,r.jsx)(s.h4,{id:"returns-112",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunreadmessages",children:"getUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnreadMessages"}),"(",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),", ",(0,r.jsx)(s.code,{children:"use_unread_count"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-76",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"use_unread_count"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-113",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunsentmessages",children:"getUnsentMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnsentMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-114",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getvcards",children:"getVCards()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getVCards"}),"(",(0,r.jsx)(s.code,{children:"msgId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Extracts vcards from a message.This works on messages of typ ",(0,r.jsx)(s.code,{children:"vcard"})," or ",(0,r.jsx)(s.code,{children:"multi_vcard"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"msgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string id of the message to extract the vcards from"}),"\n",(0,r.jsx)(s.h4,{id:"returns-115",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"[vcard]"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{children:'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n'})}),"\n",(0,r.jsx)(s.p,{children:"or false if no valid vcards found."}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.a,{href:"https://www.npmjs.com/package/vcf",children:"vcf"})," to convert a vcard string into a json object"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getwaversion",children:"getWAVersion()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getWAVersion"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-116",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ghostforward",children:"ghostForward()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"ghostForward"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.]\nAny potential abuse of this method will see it become paywalled."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-117",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"healthcheck",children:"healthCheck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"healthCheck"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-118",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"iamadmin",children:"iAmAdmin()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"iAmAdmin"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account is admin"}),"\n",(0,r.jsx)(s.h4,{id:"returns-119",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"inviteinfo",children:"inviteInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"inviteInfo"}),"(",(0,r.jsx)(s.code,{children:"link"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the details of a group through the invite link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-79",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This can be an invite link or invite code"}),"\n",(0,r.jsx)(s.h4,{id:"returns-120",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatmuted",children:"isChatMuted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatMuted"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat is muted"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-80",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat you want to check"}),"\n",(0,r.jsx)(s.h4,{id:"returns-121",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["boolean. ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatonline",children:"isChatOnline()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatOnline"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat contact is online. Not entirely sure if this works with groups."}),"\n",(0,r.jsxs)(s.p,{children:["It will return ",(0,r.jsx)(s.code,{children:"true"})," if the chat is ",(0,r.jsx)(s.code,{children:"online"}),", ",(0,r.jsx)(s.code,{children:"false"})," if the chat is ",(0,r.jsx)(s.code,{children:"offline"}),", ",(0,r.jsx)(s.code,{children:"PRIVATE"})," if the privacy settings of the contact do not allow you to see their status and ",(0,r.jsx)(s.code,{children:"NO_CHAT"})," if you do not currently have a chat with that contact."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-81",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-122",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isconnected",children:"isConnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isConnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves if the phone is online. Please note that this may not be real time."}),"\n",(0,r.jsx)(s.h4,{id:"returns-123",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"isgroupidunsafe-insiders",children:["isGroupIdUnsafe() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isGroupIdUnsafe"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-82",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat you want to deteremine is unsafe"}),"\n",(0,r.jsx)(s.h4,{id:"returns-124",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isPhoneDisconnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:['Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-125",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joingroupvialink",children:"joinGroupViaLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinGroupViaLink"}),"(",(0,r.jsx)(s.code,{children:"link"}),", ",(0,r.jsx)(s.code,{children:"returnChatObj"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Joins a group via the invite link, code, or message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-83",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This param is the string which includes the invite link or code. The following work:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["Follow this link to join my WA group: ",(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})}),"\n",(0,r.jsx)(s.li,{children:"DHTGJUfFJAV9MxOpZO1fBZ"}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have been removed from the group previously, it will return ",(0,r.jsx)(s.code,{children:"401"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"returnChatObj?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata."}),"\n",(0,r.jsx)(s.h4,{id:"returns-126",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," Either false if it didn't work, or the group id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinwebbeta",children:"joinWebBeta()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinWebBeta"}),"(",(0,r.jsx)(s.code,{children:"join"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Join or leave the wa web beta program. Will return true of operation was successful."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-84",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"join"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to join the beta, false to leave"}),"\n",(0,r.jsx)(s.h4,{id:"returns-127",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),"(",(0,r.jsx)(s.code,{children:"reason"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Shuts down the page and browser"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-85",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"reason"}),": ",(0,r.jsx)(s.code,{children:"string"})," = ",(0,r.jsx)(s.code,{children:'"MANUALLY_KILLED"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-128",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"true"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"leavegroup",children:"leaveGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"leaveGroup"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes the host device from the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-86",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-129",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"listwebhooks",children:"listWebhooks()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"listWebhooks"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreives an array of webhook objects"}),"\n",(0,r.jsx)(s.h4,{id:"returns-130",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadallearliermessages",children:"loadAllEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAllEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-87",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-131",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadandgetallmessagesinchat",children:"loadAndGetAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAndGetAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"loads and Retrieves all Messages in a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-88",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-132",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessages",children:"loadEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-89",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-133",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message []"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessagestilldate",children:"loadEarlierMessagesTillDate()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessagesTillDate"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),", ",(0,r.jsx)(s.code,{children:"timestamp"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages until a given timestamp in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-90",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"timestamp"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"in seconds"}),"\n",(0,r.jsx)(s.h4,{id:"returns-134",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logger",children:"logger()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logger"}),"(): ",(0,r.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Grab the logger for this session/process"}),"\n",(0,r.jsx)(s.h4,{id:"returns-135",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"any"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logout",children:"logout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logout"}),"(",(0,r.jsx)(s.code,{children:"preserveSessionData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Logs out from the session."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-91",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"preserveSessionData"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"skip session.data.json file invalidation\nPlease be careful when using this as it can exit the whole process depending on your config"}),"\n",(0,r.jsx)(s.h4,{id:"returns-136",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markallread",children:"markAllRead()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAllRead"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs sendSeen on all chats"}),"\n",(0,r.jsx)(s.h4,{id:"returns-137",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markasunread",children:"markAsUnread()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAsUnread"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to unread. May be useful to get host's attention"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-92",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-138",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"metrics",children:"metrics()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"metrics"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns some metrics of the session/page."}),"\n",(0,r.jsx)(s.h4,{id:"returns-139",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"middleware",children:"middleware()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"middleware"}),"(",(0,r.jsx)(s.code,{children:"useSessionIdInPath"}),", ",(0,r.jsx)(s.code,{children:"PORT"}),"?): (",(0,r.jsx)(s.code,{children:"req"}),", ",(0,r.jsx)(s.code,{children:"res"}),", ",(0,r.jsx)(s.code,{children:"next"}),") => ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n"})}),"\n",(0,r.jsxs)(s.p,{children:["All requests need to be ",(0,r.jsx)(s.code,{children:"POST"})," requests. You use the API the same way you would with ",(0,r.jsx)(s.code,{children:"client"}),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."]}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n"})}),"\n",(0,r.jsx)(s.p,{children:"as a request with a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n"})}),"\n",(0,r.jsx)(s.p,{children:"or as a request without a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n'})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-93",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"useSessionIdInPath"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean Set this to true if you want to keep each session in it's own path."}),"\n",(0,r.jsxs)(s.p,{children:["For example, if you have a session with id ",(0,r.jsx)(s.code,{children:"host"})," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.jsx)(s.code,{children:"host"}),". E.g ",(0,r.jsx)(s.code,{children:"localhost:8082/sendText"})," becomes ",(0,r.jsx)(s.code,{children:"localhost:8082/host/sendText"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"PORT?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-140",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Function"})}),"\n",(0,r.jsx)(s.h5,{id:"parameters-94",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"req"}),": ",(0,r.jsx)(s.code,{children:"Request"}),"<",(0,r.jsx)(s.code,{children:"ParamsDictionary"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"ParsedQs"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"res"}),": ",(0,r.jsx)(s.code,{children:"Response"}),"<",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"next"}),": ",(0,r.jsx)(s.code,{children:"NextFunction"})]}),"\n",(0,r.jsx)(s.h5,{id:"returns-141",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"mutechat-insiders",children:["muteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"muteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"muteDuration"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-95",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation you want to mute"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"muteDuration"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:(0,r.jsx)(s.code,{children:"ChatMuteDuration"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatMuteDuration enum of the time you want this chat to be muted for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-142",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onnewproduct-insiders",children:["onNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-96",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-143",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onorder-insiders",children:["onOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-97",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-144",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"pinchat",children:"pinChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"pinChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"pin"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Pin/Unpin chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-98",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"pin"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-145",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postimagestatus-restricted",children:["postImageStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postImageStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts an image story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-99",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-146",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"posttextstatus-restricted",children:["postTextStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postTextStatus"}),"(",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-100",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"}),"\n4: ",(0,r.jsx)(s.a,{href:"https://www.dafont.com/bebas-neue.font",children:"Bebasneue Regular"}),"\n5: ",(0,r.jsx)(s.a,{href:"https://www.fontsquirrel.com/fonts/oswald",children:"Oswald Heavy"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-147",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postthumbnailstatus-restricted",children:["postThumbnailStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postThumbnailStatus"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story with a thumbnail."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-101",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The URL to share in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 thumbnail override, if not provided the link server will try to figure it out.\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-148",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postvideostatus-restricted",children:["postVideoStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postVideoStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts a video story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-102",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-149",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"prepeventdata",children:"prepEventData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"prepEventData"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"event"}),", ",(0,r.jsx)(s.code,{children:"extras"}),"?): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-103",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"event"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"extras?"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-150",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"promoteparticipant",children:"promoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"promoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Promote Participant to Admin in Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-104",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-151",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"react",children:"react()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"react"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"emoji"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"React to a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-105",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to react to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emoji"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"1 single emoji to add to the message as a reacion"}),"\n",(0,r.jsx)(s.h4,{id:"returns-152",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"refresh",children:"refresh()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"refresh"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"}),"\n",(0,r.jsx)(s.h4,{id:"returns-153",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"registerwebhook",children:"registerWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"registerWebhook"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"events"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"concurrency"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The client can now automatically handle webhooks. Use this method to register webhooks."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-106",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The webhook url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsxs)(s.p,{children:["An array of [[SimpleListener]] enums or ",(0,r.jsx)(s.code,{children:"all"})," (to register all possible listeners)"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"concurrency"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"5"})]}),"\n",(0,r.jsx)(s.p,{children:"the amount of concurrent requests to be handled by the built in queue. Default is 5."}),"\n",(0,r.jsx)(s.h4,{id:"returns-154",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"rejectgroupjoinrequest",children:"rejectGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"rejectGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Rejects a group join request\n*"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-107",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id\n*"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group\n*"}),"\n",(0,r.jsx)(s.h4,{id:"returns-155",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeAllListeners"}),"(): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-156",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelabel",children:"removeLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-108",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-157",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeListener"}),"(",(0,r.jsx)(s.code,{children:"listener"}),"): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"//////////////////////// LISTENERS"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-109",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"listener"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-158",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeparticipant",children:"removeParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove participant of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-110",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"0000000000-00000000@g.us"})}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"000000000000@c.us"})}),"\n",(0,r.jsx)(s.h4,{id:"returns-159",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeproduct",children:"removeProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove a product from the host account's catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-111",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-160",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removewebhook",children:"removeWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes a webhook."}),"\n",(0,r.jsxs)(s.p,{children:["Returns ",(0,r.jsx)(s.code,{children:"true"})," if the webhook was found and removed. ",(0,r.jsx)(s.code,{children:"false"})," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-112",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the webhook"}),"\n",(0,r.jsx)(s.h4,{id:"returns-161",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"retruns",children:"Retruns"}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"reply",children:"reply()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),", ",(0,r.jsx)(s.code,{children:"sendSeen"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-113",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string chatid"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string reply text"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the msg id to reply to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sendSeen?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean If set to true, the chat will 'blue tick' all messages before sending the reply"}),"\n",(0,r.jsx)(s.h4,{id:"returns-162",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," false if didn't work, otherwise returns message id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"reportspam-restricted",children:["reportSpam() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reportSpam"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Report a contact for spam, block them and attempt to clear chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-114",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-163",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"resizepage",children:"resizePage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"resizePage"}),"(",(0,r.jsx)(s.code,{children:"width"}),", ",(0,r.jsx)(s.code,{children:"height"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-115",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1920"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1080"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-164",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"revokegroupinvitelink",children:"revokeGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"revokeGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Revokes the current invite link for a group chat. Any previous links will stop working"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-116",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-165",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendadvancedbuttons",children:(0,r.jsx)(s.del,{children:"sendAdvancedButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAdvancedButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"footer"}),", ",(0,r.jsx)(s.code,{children:"filename"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-117",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:(0,r.jsx)(s.code,{children:"AdvancedButton"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"Required if body is a file!!"}),"\n",(0,r.jsx)(s.h4,{id:"returns-166",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."}),(0,r.jsx)(s.p,{children:"THIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send advanced buttons with media body. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.p,{children:"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendaudio",children:"sendAudio()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAudio"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send an audio file with the default audio player (not PTT/voice message)"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-118",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-167",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbanner",children:"sendBanner()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendBanner"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"base64"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a banner image"}),"\n",(0,r.jsx)(s.p,{children:"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-119",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"base64 encoded jpeg"}),"\n",(0,r.jsx)(s.h4,{id:"returns-168",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbuttons",children:(0,r.jsx)(s.del,{children:"sendButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"title"}),"?, ",(0,r.jsx)(s.code,{children:"footer"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-120",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,r.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title/header of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-169",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-3",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send generic quick reply buttons. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcontact",children:"sendContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendContact"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-121",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-170",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcustomproduct",children:(0,r.jsx)(s.del,{children:"sendCustomProduct()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendCustomProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"productData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-122",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productData"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:(0,r.jsx)(s.code,{children:"CustomProduct"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-171",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-4",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Feature Currently only available with Premium License accounts."}),"\n",(0,r.jsx)(s.p,{children:"Send a custom product to a chat. Please see [[CustomProduct]] for details."}),"\n",(0,r.jsx)(s.p,{children:"Caveats:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"URL will not work (unable to click), you will have to send another message with the URL."}),"\n",(0,r.jsx)(s.li,{children:'Recipient will see a thin banner under picture that says "Something went wrong"'}),"\n",(0,r.jsx)(s.li,{children:"This will only work if you have at least 1 product already in your catalog"}),"\n",(0,r.jsx)(s.li,{children:"Only works on Business accounts"}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendemoji",children:"sendEmoji()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendEmoji"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"emojiId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a discord emoji to a chat as a sticker"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-123",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emojiId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["The discord emoji id without indentifying chars. In discord you would write ",(0,r.jsx)(s.code,{children:":who:"}),", here use ",(0,r.jsx)(s.code,{children:"who"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-172",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfile",children:"sendFile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFile"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"}),"\n",(0,r.jsxs)(s.p,{children:["Please note that any file that resolves to mime-type ",(0,r.jsx)(s.code,{children:"octet-stream"})," will, by default, resolve to an MP4 file."]}),"\n",(0,r.jsxs)(s.p,{children:["If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.jsx)(s.a,{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",children:"https://www.iana.org/assignments/media-types/media-types.xhtml"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-124",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string xxxxx With an ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"INSIDERS LICENSE-KEY"})," you can also tag people in groups with ",(0,r.jsx)(s.code,{children:"@[number]"}),". For example if you want to mention the user with the number ",(0,r.jsx)(s.code,{children:"44771234567"}),", just add ",(0,r.jsx)(s.code,{children:"@44771234567"})," in the caption."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-173",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfilefromurl",children:"sendFileFromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFileFromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file by Url or custom options"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-125",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string 'video.mp4'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-174",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphy",children:"sendGiphy()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphy"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-126",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif",children:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"})," => ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsx)(s.h4,{id:"returns-175",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphyassticker",children:"sendGiphyAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphyAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a giphy GIF as an animated sticker."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-127",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"URL"})]}),"\n",(0,r.jsxs)(s.p,{children:["URL | string This is the giphy media url and has to be in the format ",(0,r.jsx)(s.code,{children:"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif"})," or it can be just the id ",(0,r.jsx)(s.code,{children:"RJKHjCAdsAfQPn03qQ"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-176",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimage",children:"sendImage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a image to given chat, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-128",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-177",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimageassticker",children:"sendImageAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-129",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-178",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendimageasstickerasreply-insiders",children:["sendImageAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image and sends it as a sticker to the recipient as a reply to another message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-130",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.p,{children:"Sticker metadata"}),"\n",(0,r.jsx)(s.h4,{id:"returns-179",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimagewithproduct",children:"sendImageWithProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageWithProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"bizNumber"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends product with image to chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-131",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the caption you want to add to this message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"bizNumber"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the @c.us number of the business account from which you want to grab the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string the id of the product within the main catalog of the aforementioned business"}),"\n",(0,r.jsx)(s.h4,{id:"returns-180",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlinkwithautopreview",children:"sendLinkWithAutoPreview()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLinkWithAutoPreview"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),"?, ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-132",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-181",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlistmessage",children:(0,r.jsx)(s.del,{children:"sendListMessage()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendListMessage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"sections"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"actionText"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-133",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sections"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,r.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The Sections of rows for the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The description of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"actionText"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The action text of the list message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-182",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-5",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."}),(0,r.jsx)(s.p,{children:"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE"})]}),"\n",(0,r.jsx)(s.p,{children:"Send a list message. This will not work when being sent from business accounts!"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlocation",children:"sendLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLocation"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"lat"}),", ",(0,r.jsx)(s.code,{children:"lng"}),", ",(0,r.jsx)(s.code,{children:"loc"}),", ",(0,r.jsx)(s.code,{children:"address"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Note: ",(0,r.jsx)(s.code,{children:"address"})," and ",(0,r.jsx)(s.code,{children:"url"})," are parameters available to insiders only."]}),"\n",(0,r.jsx)(s.p,{children:"Sends a location message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-134",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lat"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"latitude: '51.5074'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lng"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"longitude: '0.1278'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"loc"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"location text: 'LONDON!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"address?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"address text: '1 Regents Park!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["address text link: '",(0,r.jsx)(s.a,{href:"https://example.com",children:"https://example.com"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-183",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmessagewiththumb",children:"sendMessageWithThumb()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMessageWithThumb"}),"(",(0,r.jsx)(s.code,{children:"thumb"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a link to a chat that includes a link preview."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-135",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumb"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The link you want to send"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the link"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The long description of the link preview"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat you want to send this message to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-184",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmp4assticker",children:"sendMp4AsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMp4AsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"processOptions"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?, ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-136",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsx)(s.p,{children:"[[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"processOptions"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,r.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})," = ",(0,r.jsx)(s.code,{children:"defaultProcessOptions"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-185",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendmultiplecontacts-insiders",children:["sendMultipleContacts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMultipleContacts"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactIds"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends multiple contacts as a single message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-137",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactIds"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-186",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpaymentrequest",children:"sendPaymentRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPaymentRequest"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"amount"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[UNTESTED - REQUIRES FEEDBACK]\nSends a payment request message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-138",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"amount"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number the amount to request in 1000 format (e.g \xa310 => 10000)"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The 3 letter currency code"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string optional message to send with the payment request"}),"\n",(0,r.jsx)(s.h4,{id:"returns-187",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpoll",children:"sendPoll()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPoll"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"options"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"allowMultiSelect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a poll to a group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-139",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id - a group chat is required"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the name of the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"an array of poll options"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"A message to quote when sending the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"allowMultiSelect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not to allow multiple selections. default false"}),"\n",(0,r.jsx)(s.h4,{id:"returns-188",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendproduct-insiders",children:["sendProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendProduct"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Send a product to a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-140",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-189",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"MessageID"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendptt",children:"sendPtt()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPtt"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-141",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 data",":image","/xxx;base64,xxx or the path of the file you want to send."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-190",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendrawwebpassticker",children:"sendRawWebpAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-142",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-191",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendrawwebpasstickerasreply-insiders",children:["sendRawWebpAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-143",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"MessageId Message ID of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-192",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendreplywithmentions",children:"sendReplyWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendReplyWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"replyMessageId"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-144",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"replyMessageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-193",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendseen",children:"sendSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to seen. Marks all messages as ack: 3"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-145",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-194",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendstickerfromurl",children:"sendStickerfromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker (including GIF) from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-146",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-195",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendstickerfromurlasreply-insiders",children:["sendStickerfromUrlAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrlAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-147",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the image"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-196",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendtext-restricted",children:["sendText() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendText"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a text message to given chat"}),"\n",(0,r.jsxs)(s.p,{children:["A license is ",(0,r.jsx)(s.strong,{children:"NOT"})," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-148",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-197",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendtextwithmentions",children:"sendTextWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendTextWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-149",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-198",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvcard",children:"sendVCard()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVCard"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"vcard"}),", ",(0,r.jsx)(s.code,{children:"contactName"}),"?, ",(0,r.jsx)(s.code,{children:"contactNumber"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send VCARD"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-150",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"vcard"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"vcard as a string, you can send multiple contacts vcard also."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactName?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The display name for the contact. Ignored on multiple vcards"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactNumber?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g:\n",(0,r.jsx)(s.code,{children:"4477777777777"}),"\nIgnored on multiple vcards"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-199",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvideoasgif",children:"sendVideoAsGif()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVideoAsGif"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-151",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-200",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendyoutubelink",children:"sendYoutubeLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendYoutubeLink"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-152",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A youtube link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})," = ",(0,r.jsx)(s.code,{children:"''"})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-201",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatbackgroundcolourhex-insiders",children:["setChatBackgroundColourHex() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatBackgroundColourHex"}),"(",(0,r.jsx)(s.code,{children:"hex"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Set the wallpaper background colour"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-153",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hex"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"'#FFF123'"}),"\n",(0,r.jsx)(s.h4,{id:"returns-202",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatephemeral-insiders",children:["setChatEphemeral() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatEphemeral"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"ephemeral"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Turn the ephemeral setting in a chat to on or off"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-154",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the chat"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ephemeral"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:(0,r.jsx)(s.code,{children:"EphemeralDuration"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," to turn on the ephemeral setting to 1 day, ",(0,r.jsx)(s.code,{children:"false"})," to turn off the ephemeral setting. Other options: ",(0,r.jsx)(s.code,{children:"604800 | 7776000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-203",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true if the setting was set, ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setchatstate",children:"setChatState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatState"}),"(",(0,r.jsx)(s.code,{children:"chatState"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the chat state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-155",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatState"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:(0,r.jsx)(s.code,{children:"ChatState"})})]}),"\n",(0,r.jsx)(s.p,{children:"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2)."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-204",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupapprovalmode",children:"setGroupApprovalMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupApprovalMode"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"requireApproval"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Turn on or off the approval requirement for new members to join a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-156",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requireApproval"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"set to true to turn on the approval requirement, false to turn off"}),"\n",(0,r.jsx)(s.h4,{id:"returns-205",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupdescription",children:"setGroupDescription()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupDescription"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"description"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the group chant description"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-157",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group description"}),"\n",(0,r.jsx)(s.h4,{id:"returns-206",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupedittoadminsonly",children:"setGroupEditToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupEditToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot edit a groups details"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-158",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-207",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupicon",children:"setGroupIcon()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIcon"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"image"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-159",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-208",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupiconbyurl",children:"setGroupIconByUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIconByUrl"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-160",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-209",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setgrouptitle-insiders",children:["setGroupTitle() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupTitle"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"title"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Change the group chat title"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-161",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group title"}),"\n",(0,r.jsx)(s.h4,{id:"returns-210",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgrouptoadminsonly",children:"setGroupToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot speak in a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-162",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-211",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmyname",children:"setMyName()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyName"}),"(",(0,r.jsx)(s.code,{children:"newName"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set your profile name"}),"\n",(0,r.jsx)(s.p,{children:"Please note, this does not work on business accounts!"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-163",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new name to set for your profile"}),"\n",(0,r.jsx)(s.h4,{id:"returns-212",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmystatus",children:"setMyStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyStatus"}),"(",(0,r.jsx)(s.code,{children:"newStatus"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"set your about me"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-164",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newStatus"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new profile status"}),"\n",(0,r.jsx)(s.h4,{id:"returns-213",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setpresence",children:"setPresence()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setPresence"}),"(",(0,r.jsx)(s.code,{children:"available"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set presence to available or unavailable."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-165",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"available"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);"}),"\n",(0,r.jsx)(s.h4,{id:"returns-214",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setprofilepic",children:"setProfilePic()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setProfilePic"}),"(",(0,r.jsx)(s.code,{children:"data"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the profile pic of the host number."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-166",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"string data url image string."}),"\n",(0,r.jsx)(s.h4,{id:"returns-215",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," success if true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulaterecording",children:"simulateRecording()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateRecording"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...recording' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-167",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated recording, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-216",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulatetyping",children:"simulateTyping()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateTyping"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...typing' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-168",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated typing, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-217",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"starmessage",children:"starMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"starMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Star a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-169",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to star"}),"\n",(0,r.jsx)(s.h4,{id:"returns-218",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"synccontacts",children:"syncContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"syncContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Syncs contacts with phone. This promise does not resolve so it will instantly return true."}),"\n",(0,r.jsx)(s.h4,{id:"returns-219",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"tageveryone-insiders",children:["tagEveryone() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"tagEveryone"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"formatting"}),"?, ",(0,r.jsx)(s.code,{children:"messageBeforeTags"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Tags everyone in the group with a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-170",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@g.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message to add under all of the tags"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"formatting?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The formatting of the tags. Use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageBeforeTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["set to ",(0,r.jsx)(s.code,{children:"true"})," to show the message before all of the tags"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-220",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.h4,{id:"mention",children:"Mention"}),"\n",(0,r.jsx)(s.p,{children:"to indicate the actual tag."}),"\n",(0,r.jsx)(s.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"@mention "})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testbuttons",children:(0,r.jsx)(s.del,{children:"testButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testButtons"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-171",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-221",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-6",children:"Deprecated"}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testcallback",children:"testCallback()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testCallback"}),"(",(0,r.jsx)(s.code,{children:"callbackToTest"}),", ",(0,r.jsx)(s.code,{children:"testData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this simple command to test firing callback events."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-172",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"callbackToTest"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"testData"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-222",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if the callback was not registered/does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"unmutechat-insiders",children:["unmuteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unmuteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Unmutes a conversation."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-173",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-223",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"unstarmessage",children:"unstarMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unstarMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unstar a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-174",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to unstar"}),"\n",(0,r.jsx)(s.h4,{id:"returns-224",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"updatewebhook",children:"updateWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"updateWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),", ",(0,r.jsx)(s.code,{children:"events"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]]."}),"\n",(0,r.jsx)(s.p,{children:"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-175",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-225",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitallqempty",children:"waitAllQEmpty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitAllQEmpty"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for all queues to be empty"}),"\n",(0,r.jsx)(s.h4,{id:"returns-226",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitwhqidle",children:"waitWhQIdle()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitWhQIdle"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-227",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"events",children:"Events"}),"\n",(0,r.jsx)(s.h3,{id:"onack-1",children:"onAck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to messages acknowledgement Changes"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-176",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-228",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onaddedtogroup-1",children:"onAddedToGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is added to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-177",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-229",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onanymessage-1",children:"onAnyMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all new messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-178",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-230",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbattery-1",children:(0,r.jsx)(s.del,{children:"onBattery()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-179",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-231",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-7",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Listens to battery changes"}),"\n",(0,r.jsx)(s.admonition,{type:"caution",children:(0,r.jsx)(s.p,{children:"This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers."})}),"\n",(0,r.jsx)(s.h4,{id:"fires-1",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbroadcast-1",children:"onBroadcast()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to broadcast messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-180",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-232",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-2",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbutton-1",children:"onButton()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to button message responses"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-181",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-233",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-3",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"oncallstate-1",children:"onCallState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes on call state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-182",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-234",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onchatdeleted-1",children:"onChatDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a chat is deleted by the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-183",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-235",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-4",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Chat]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatopened-insiders",children:["onChatOpened() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-184",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ChatId]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-236",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatstate-insiders",children:["onChatState() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to chat state, including when a specific user is recording and typing within a group chat."}),"\n",(0,r.jsx)(s.p,{children:"Here is an example of the fired object:"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-185",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-237",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-5",children:"Fires"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n'})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"oncontactadded-insiders",children:["onContactAdded() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with contact id when a new contact is added on the host phone."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-186",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-238",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onglobalparticipantschanged-1",children:"onGlobalParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-187",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-239",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupapprovalrequest-1",children:"onGroupApprovalRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Listents to group approval requests. Emits a message object. Use it with ",(0,r.jsx)(s.code,{children:"message.isGroupApprovalRequest()"})," to check if it is a group approval request."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-188",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-240",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupchange-1",children:"onGroupChange()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-189",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-241",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onincomingcall-1",children:"onIncomingCall()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to new incoming calls"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-190",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-242",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call request objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlabel-1",children:"onLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to label change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-191",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-243",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-6",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Label]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlivelocation",children:"onLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to live locations from a chat that already has valid live locations"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-192",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"the chat from which you want to subscribes to live location updates"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback that takes in a LiveLocationChangedEvent"}),"\n",(0,r.jsx)(s.h4,{id:"returns-244",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean, if returns false then there were no valid live locations in the chat of chatId"}),"\n",(0,r.jsx)(s.h4,{id:"emits",children:"Emits"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:""})," LiveLocationChangedEvent"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlogout-1",children:"onLogout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"priority"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to a log out event"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-193",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"priority?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks"}),"\n",(0,r.jsx)(s.h4,{id:"returns-245",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-7",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessage-1",children:"onMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to incoming messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-194",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-246",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-8",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessagedeleted-1",children:"onMessageDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a message is deleted by a recipient or the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-195",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-247",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-9",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onparticipantschanged",children:"onParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"legacy"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-196",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group id: ",(0,r.jsx)(s.a,{href:"mailto:xxxxx-yyyy@c.us",children:"xxxxx-yyyy@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"legacy"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-248",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of participantChangedEvent"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onplugged-1",children:"onPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when host device is plugged/unplugged"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-197",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-249",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-10",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"boolean true if plugged, false if unplugged"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onpollvote-1",children:"onPollVote()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to poll vote events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-198",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-250",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-11",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[PollData]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onreaction-insiders",children:["onReaction() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to reaction add and change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-199",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-251",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-12",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[ReactionEvent]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onremovedfromgroup-insiders",children:["onRemovedFromGroup() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is removed to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-200",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-252",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onstatechanged-1",children:"onStateChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes in state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-201",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-253",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-13",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"STATE observable sream of states"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onstory-restricted",children:["onStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a contact posts a new story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-202",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-254",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-14",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"e.g"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>c});var r=n(6540);const i={},d=r.createContext(i);function l(e){const s=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/26af37c4.4a567b44.js b/assets/js/26af37c4.4a567b44.js deleted file mode 100644 index 28bc7c9c96..0000000000 --- a/assets/js/26af37c4.4a567b44.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8745],{8114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var r=n(4848),i=n(8453);const d={},l="Class: Client",c={id:"reference/api/Client/classes/Client",title:"Class: Client",description:"Methods",source:"@site/docs/reference/api/Client/classes/Client.md",sourceDirName:"reference/api/Client/classes",slug:"/reference/api/Client/classes/Client",permalink:"/docs/reference/api/Client/classes/Client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/classes/Client.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/Client",permalink:"/docs/reference/api/Client/"},next:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"}},t={},a=[{value:"Methods",id:"methods",level:2},{value:'B()
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Example",id:"example",level:4},{value:"acceptGroupJoinRequest()",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel()",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant()",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest()",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat()",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject()",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages()",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-1",level:4},{value:"checkNumberStatus()",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts()
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats()",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat()",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock()",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock()",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity()
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup()",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel()
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector()",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct()
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache()",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"after",id:"after",level:5},{value:"after.chats",id:"afterchats",level:5},{value:"after.msgs",id:"aftermsgs",level:5},{value:"before",id:"before",level:5},{value:"before.chats",id:"beforechats",level:5},{value:"before.msgs",id:"beforemsgs",level:5},{value:"cutMsgCache()",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode()",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia()",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus()",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories()
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat()",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage()",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats()",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus()",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory()
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant()",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download()",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials()",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage()",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage()",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct()
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages()",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus()",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate()
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState()",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation()",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages()",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc()",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds()",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats()",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages()",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"getAllCommunities()",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts()",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups()",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels()",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat()",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages()",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages()",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages()",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel()",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"getBlockedIds()",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile()",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts()",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat()",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById()",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts()",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel()",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Label",id:"label",level:4},{value:'getCommonGroups()
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds()",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins()",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo()",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds()",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants()",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState()",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact()",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature()",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures()",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent()",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray()",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins()",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests()",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo()",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink()",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers()",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId()",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber()",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages()",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId()",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged()",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink()",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups()",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps()",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen()",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink()",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType()",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues()",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"onAck",id:"onack",level:5},{value:"onAddedToGroup",id:"onaddedtogroup",level:5},{value:"onAnyMessage",id:"onanymessage",level:5},{value:"onBattery",id:"onbattery",level:5},{value:"onBroadcast",id:"onbroadcast",level:5},{value:"onButton",id:"onbutton",level:5},{value:"onCallState",id:"oncallstate",level:5},{value:"onChatDeleted",id:"onchatdeleted",level:5},{value:"onChatOpened",id:"onchatopened",level:5},{value:"onChatState",id:"onchatstate",level:5},{value:"onContactAdded",id:"oncontactadded",level:5},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:5},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:5},{value:"onGroupChange",id:"ongroupchange",level:5},{value:"onIncomingCall",id:"onincomingcall",level:5},{value:"onLabel",id:"onlabel",level:5},{value:"onLogout",id:"onlogout",level:5},{value:"onMessage",id:"onmessage",level:5},{value:"onMessageDeleted",id:"onmessagedeleted",level:5},{value:"onNewProduct",id:"onnewproduct",level:5},{value:"onOrder",id:"onorder",level:5},{value:"onPlugged",id:"onplugged",level:5},{value:"onPollVote",id:"onpollvote",level:5},{value:"onReaction",id:"onreaction",level:5},{value:"onRemovedFromGroup",id:"onremovedfromgroup",level:5},{value:"onStateChanged",id:"onstatechanged",level:5},{value:"onStory",id:"onstory",level:5},{value:"getMe()",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById()",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo()
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders()",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage()",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray()",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray()
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder()
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage()",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData()",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats()",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer()",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId()",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo()",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty()",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot()",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages()",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus()",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"id",id:"id",level:5},{value:"status",id:"status",level:5},{value:"getStickerDecryptable()",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:"Deprecated",id:"deprecated-1",level:4},{value:'getStoryViewers()
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode()",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages()",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages()",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards()",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion()",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward()",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck()",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin()",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo()",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted()",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline()",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected()",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe()
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected()",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink()",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta()",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill()",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup()",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks()",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages()",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat()",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages()",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate()",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger()",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout()",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead()",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread()",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics()",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware()",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat()
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct()
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder()
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat()",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus()
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus()
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postThumbnailStatus()
restricted
',id:"postthumbnailstatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:'postVideoStatus()
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"prepEventData()",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"promoteParticipant()",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"react()",id:"react",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-152",level:4},{value:"refresh()",id:"refresh",level:3},{value:"Returns",id:"returns-153",level:4},{value:"registerWebhook()",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"rejectGroupJoinRequest()",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-155",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-156",level:4},{value:"removeLabel()",id:"removelabel",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeParticipant()",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeProduct()",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"removeWebhook()",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:"Retruns",id:"retruns",level:4},{value:"reply()",id:"reply",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:'reportSpam()
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"resizePage()",id:"resizepage",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"revokeGroupInviteLink()",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAdvancedButtons()",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"Deprecated",id:"deprecated-2",level:4},{value:"sendAudio()",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendBanner()",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendButtons()",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"sendContact()",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendCustomProduct()",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"sendEmoji()",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFile()",id:"sendfile",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendFileFromUrl()",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphy()",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendGiphyAsSticker()",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImage()",id:"sendimage",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:"sendImageAsSticker()",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:'sendImageAsStickerAsReply()
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendImageWithProduct()",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendLinkWithAutoPreview()",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendListMessage()",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"sendLocation()",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMessageWithThumb()",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:"sendMp4AsSticker()",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:'sendMultipleContacts()
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPaymentRequest()",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:"sendPoll()",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:'sendProduct()
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendPtt()",id:"sendptt",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:"sendRawWebpAsSticker()",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:'sendRawWebpAsStickerAsReply()
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendReplyWithMentions()",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendSeen()",id:"sendseen",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:"sendStickerfromUrl()",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendStickerfromUrlAsReply()
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:'sendText()
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendTextWithMentions()",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVCard()",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendVideoAsGif()",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:"sendYoutubeLink()",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatBackgroundColourHex()
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:'setChatEphemeral()
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setChatState()",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupApprovalMode()",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupDescription()",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupEditToAdminsOnly()",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIcon()",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:"setGroupIconByUrl()",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:'setGroupTitle()
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setGroupToAdminsOnly()",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyName()",id:"setmyname",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setMyStatus()",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setPresence()",id:"setpresence",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"setProfilePic()",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateRecording()",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"simulateTyping()",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"starMessage()",id:"starmessage",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-218",level:4},{value:"syncContacts()",id:"synccontacts",level:3},{value:"Returns",id:"returns-219",level:4},{value:'tagEveryone()
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"Mention",id:"mention",level:4},{value:"Default",id:"default",level:4},{value:"testButtons()",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"testCallback()",id:"testcallback",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:'unmuteChat()
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"unstarMessage()",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"updateWebhook()",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-225",level:4},{value:"waitAllQEmpty()",id:"waitallqempty",level:3},{value:"Returns",id:"returns-226",level:4},{value:"waitWhQIdle()",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-227",level:4},{value:"Events",id:"events",level:2},{value:"onAck()",id:"onack-1",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAddedToGroup()",id:"onaddedtogroup-1",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onAnyMessage()",id:"onanymessage-1",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"Fires",id:"fires",level:4},{value:"onBattery()",id:"onbattery-1",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"Deprecated",id:"deprecated-7",level:4},{value:"Fires",id:"fires-1",level:4},{value:"onBroadcast()",id:"onbroadcast-1",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"Fires",id:"fires-2",level:4},{value:"onButton()",id:"onbutton-1",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"Fires",id:"fires-3",level:4},{value:"onCallState()",id:"oncallstate-1",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:"onChatDeleted()",id:"onchatdeleted-1",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:"Fires",id:"fires-4",level:4},{value:'onChatOpened()
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onChatState()
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"Fires",id:"fires-5",level:4},{value:'onContactAdded()
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGlobalParticipantsChanged()",id:"onglobalparticipantschanged-1",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupApprovalRequest()",id:"ongroupapprovalrequest-1",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onGroupChange()",id:"ongroupchange-1",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onIncomingCall()",id:"onincomingcall-1",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLabel()",id:"onlabel-1",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"Fires",id:"fires-6",level:4},{value:"onLiveLocation()",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"Emits",id:"emits",level:4},{value:"onLogout()",id:"onlogout-1",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"Fires",id:"fires-7",level:4},{value:"onMessage()",id:"onmessage-1",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"Fires",id:"fires-8",level:4},{value:"onMessageDeleted()",id:"onmessagedeleted-1",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"Fires",id:"fires-9",level:4},{value:"onParticipantsChanged()",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPlugged()",id:"onplugged-1",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:"Fires",id:"fires-10",level:4},{value:"onPollVote()",id:"onpollvote-1",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:"Fires",id:"fires-11",level:4},{value:'onReaction()
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"Fires",id:"fires-12",level:4},{value:'onRemovedFromGroup()
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:"onStateChanged()",id:"onstatechanged-1",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4},{value:"Fires",id:"fires-13",level:4},{value:'onStory()
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-202",level:4},{value:"Returns",id:"returns-254",level:4},{value:"Fires",id:"fires-14",level:4}];function o(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"class-client",children:"Class: Client"}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsxs)(s.h3,{id:"b-insiders",children:["B() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"B"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"payload"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Use a raw payload within your open-wa session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"payload"})]}),"\n",(0,r.jsx)(s.p,{children:"returns: MessageId"}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(s.p,{children:"If there is a code block, then both TypeDoc and VSCode will treat\ntext outside of the code block as regular text."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"await B('44123456789@c.us', {\n test: 1\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client#loadallearliermessages",children:"loadAllEarlierMessages"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"acceptgroupjoinrequest",children:"acceptGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"acceptGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Accepts a request from a recipient to join a group. Takes the message ID of the request message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addlabel",children:"addLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addparticipant",children:"addParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Add participant to Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the contacts, returns ",(0,r.jsx)(s.code,{children:"NOT_A_CONTACT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"approvegroupjoinrequest",children:"approveGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"approveGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Approves a group join request"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"archivechat",children:"archiveChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"archiveChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"archive"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"archive"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean true => archive, false => unarchive"}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked, false: didnt work (probably already in desired state)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"autoreject",children:"autoReject()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"autoReject"}),"(",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."}),"\n",(0,r.jsx)(s.p,{children:"Update: Due to the nature of MD, the host account will continue ringing."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional message to send to the calling account when their call is detected and rejected"}),"\n",(0,r.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"awaitmessages",children:"awaitMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"awaitMessages"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[FROM DISCORDJS]\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"The filter function to use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,r.jsx)(s.code,{children:"AwaitMessagesOptions"})})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsx)(s.p,{children:"Optional options to pass to the internal collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n",(0,r.jsx)(s.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"checknumberstatus",children:"checkNumberStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkNumberStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a number is a valid WA number"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"checkreadreceipts-insiders",children:["checkReadReceipts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkReadReceipts"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Check if a recipient has read receipts on."}),"\n",(0,r.jsx)(s.p,{children:"This will only work if you have chats sent back and forth between you and the contact 1-1."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Id of the contact with which you have an existing conversation with messages already."}),"\n",(0,r.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearallchats",children:"clearAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearAllChats"}),"(",(0,r.jsx)(s.code,{children:"ts"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ts?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number A chat that has had a message after ts (epoch timestamp) will not be cleared."}),"\n",(0,r.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearchat",children:"clearChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete all messages from the chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactblock",children:"contactBlock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactBlock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Block contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactunblock",children:"contactUnblock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactUnblock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unblock contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createcommunity-insiders",children:["createCommunity() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createCommunity"}),"(",(0,r.jsx)(s.code,{children:"communityName"}),", ",(0,r.jsx)(s.code,{children:"communitySubject"}),", ",(0,r.jsx)(s.code,{children:"icon"}),", ",(0,r.jsx)(s.code,{children:"existingGroups"}),", ",(0,r.jsx)(s.code,{children:"newGroups"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Create a new community"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The community name"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communitySubject"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"icon"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"DataURL of a 1:1 ratio jpeg for the community icon"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"existingGroups"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[] = ",(0,r.jsx)(s.code,{children:"[]"})]}),"\n",(0,r.jsx)(s.p,{children:"An array of existing group IDs, that are not already part of a community, to add to this new community."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newGroups?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:(0,r.jsx)(s.code,{children:"NewCommunityGroup"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of new group objects that"}),"\n",(0,r.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"creategroup",children:"createGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createGroup"}),"(",(0,r.jsx)(s.code,{children:"groupName"}),", ",(0,r.jsx)(s.code,{children:"contacts"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a group and add contacts to it"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"group name: 'New group'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contacts"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createlabel-insiders",children:["createLabel() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.jsx)(s.code,{children:'"58"'}),")"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"createmessagecollector",children:"createMessageCollector()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createMessageCollector"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"): ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a new message collector for the chat which is related to the first parameter c"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,r.jsx)(s.code,{children:"CollectorOptions"})})]}),"\n",(0,r.jsx)(s.p,{children:"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc."}),"\n",(0,r.jsx)(s.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createnewproduct-insiders",children:["createNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createNewProduct"}),"(",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"price"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"images"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Add a product to your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutchatcache",children:"cutChatCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutChatCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-19",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"after",children:"after"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"after"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"afterchats",children:"after.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"aftermsgs",children:"after.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"before",children:"before"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"before"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforechats",children:"before.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforemsgs",children:"before.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutmsgcache",children:"cutMsgCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutMsgCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-20",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"darkmode",children:"darkMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"darkMode"}),"(",(0,r.jsx)(s.code,{children:"activate"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Start dark mode [NOW GENERALLY AVAILABLE]"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"activate"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to activate dark mode, false to deactivate"}),"\n",(0,r.jsx)(s.h4,{id:"returns-21",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"decryptmedia",children:"decryptMedia()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"decryptMedia"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Decrypts a media message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.p,{children:"This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID."}),"\n",(0,r.jsx)(s.h4,{id:"returns-22",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise<[[DataURL]]>"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deleteallstatus",children:"deleteAllStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStatus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-23",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deleteallstories-restricted",children:["deleteAllStories() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStories"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Deletes all your existing stories."}),"\n",(0,r.jsx)(s.h4,{id:"returns-24",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletechat",children:"deleteChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete the conversation from your WA"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-25",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletemessage",children:"deleteMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"onlyLocal"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Deletes message of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat id from which to delete the message."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The specific message id of the message to be deleted"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyLocal"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false."}),"\n",(0,r.jsx)(s.h4,{id:"returns-26",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"nothing"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestalechats",children:"deleteStaleChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStaleChats"}),"(",(0,r.jsx)(s.code,{children:"startingFrom"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.jsx)(s.code,{children:"100"})," then all chats from index ",(0,r.jsx)(s.code,{children:"100"})," onwards will be deleted."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"startingFrom?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.jsx)(s.code,{children:"1000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-27",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestatus",children:"deleteStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStatus"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-28",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deletestory-restricted",children:["deleteStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStory"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Consumes a list of id strings of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"string [] | string an array of ids of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"returns-29",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"demoteparticipant",children:"demoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"demoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Demote Admin of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-30",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"download",children:"download()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"download"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"optionsOverride"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A convinience method to download the [[DataURL]] of a file"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"optionsOverride"}),": ",(0,r.jsx)(s.code,{children:"any"})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:["You can use this to override the ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"axios request config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-31",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadfilewithcredentials",children:"downloadFileWithCredentials()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadFileWithCredentials"}),"(",(0,r.jsx)(s.code,{children:"url"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download via the browsers authenticated session via URL."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-32",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"base64 string (non-data url)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadprofilepicfrommessage",children:"downloadProfilePicFromMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadProfilePicFromMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download profile pics from the message object."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-33",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"editmessage",children:"editMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"text"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"NOTE: This is experimental, most accounts do not have access to this feature in their apps."}),"\n",(0,r.jsx)(s.p,{children:"Edit an existing message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message ID to edit"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The new text content"}),"\n",(0,r.jsx)(s.h4,{id:"returns-34",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"editproduct-insiders",children:["editProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),", ",(0,r.jsx)(s.code,{children:"name"}),"?, ",(0,r.jsx)(s.code,{children:"price"}),"?, ",(0,r.jsx)(s.code,{children:"currency"}),"?, ",(0,r.jsx)(s.code,{children:"images"}),"?, ",(0,r.jsx)(s.code,{children:"description"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Edit a product in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The catalog ID of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-35",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"emitunreadmessages",children:"emitUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"emitUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."}),"\n",(0,r.jsx)(s.h4,{id:"returns-36",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of message IDs"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forcerefocus",children:"forceRefocus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceRefocus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is a convinient method to click the ",(0,r.jsx)(s.code,{children:"Use Here"})," button in the WA web session."]}),"\n",(0,r.jsxs)(s.p,{children:["Use this when [[STATE]] is ",(0,r.jsx)(s.code,{children:"CONFLICT"}),". You can read more about managing state here:"]}),"\n",(0,r.jsx)(s.p,{children:"[[Detecting Logouts]]"}),"\n",(0,r.jsx)(s.h4,{id:"returns-37",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"forcestalemediaupdate-insiders",children:["forceStaleMediaUpdate() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceStaleMediaUpdate"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."}),"\n",(0,r.jsx)(s.p,{children:"if you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-32",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-38",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["[[Message]] OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdateconnectionstate",children:"forceUpdateConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateConnectionState"}),"(",(0,r.jsx)(s.code,{children:"killBeforeReconnect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forces the session to update the connection state."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"killBeforeReconnect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-39",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"updated connection state"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdatelivelocation",children:"forceUpdateLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Id of the chat you want to force the phone to get the livelocation data for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-40",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," | boolean"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forwardmessages",children:"forwardMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forwardMessages"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messages"}),", ",(0,r.jsx)(s.code,{children:"skipMyMessages"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forward an array of messages to a specific chat using the message ids or Objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messages"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"this can be any mixture of message ids or message objects"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"skipMyMessages"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"This indicates whether or not to skip your own messages from the array"}),"\n",(0,r.jsx)(s.h4,{id:"returns-41",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gc",children:"gc()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"gc"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"It calls the JavaScript garbage collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-42",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Nothing."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatids",children:"getAllChatIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves all Chat Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-43",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [ChatId]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchats",children:"getAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChats"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-44",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatswithmessages",children:(0,r.jsx)(s.del,{children:"getAllChatsWithMessages()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatsWithMessages"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-45",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats with messages"}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.code,{children:"getAllUnreadMessages"})," instead of this to see all messages indicated by the green dots in the chat."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcommunities",children:"getAllCommunities()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllCommunities"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all commmunity Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-46",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of group ids"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcontacts",children:"getAllContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all contacts"}),"\n",(0,r.jsx)(s.h4,{id:"returns-47",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Contact]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallgroups",children:"getAllGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllGroups"}),"(",(0,r.jsx)(s.code,{children:"withNewMessagesOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all groups"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessagesOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-48",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of groups"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getalllabels",children:"getAllLabels()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllLabels"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns all labels and the corresponding tagged items."}),"\n",(0,r.jsx)(s.h4,{id:"returns-49",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallmessagesinchat",children:"getAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all Messages in a chat that have been loaded within the WA web instance."}),"\n",(0,r.jsx)(s.p,{children:"This does not load every single message in the chat history."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-50",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallnewmessages",children:"getAllNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all new Messages. where isNewMsg==true"}),"\n",(0,r.jsx)(s.h4,{id:"returns-51",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallunreadmessages",children:"getAllUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages. where ack==-1"}),"\n",(0,r.jsx)(s.h4,{id:"returns-52",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getamountofloadedmessages",children:"getAmountOfLoadedMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAmountOfLoadedMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."}),"\n",(0,r.jsx)(s.h4,{id:"returns-53",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbatterylevel",children:"getBatteryLevel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBatteryLevel"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves Battery Level"}),"\n",(0,r.jsx)(s.h4,{id:"returns-54",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getblockedids",children:"getBlockedIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBlockedIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves an array of IDs of accounts blocked by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"returns-55",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofile",children:"getBusinessProfile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfile"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the business info of a given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-56",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofilesproducts",children:"getBusinessProfilesProducts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfilesProducts"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Find any product listings of the given number. Use this to query a catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-41",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-57",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchat",children:"getChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChat"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-42",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-58",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatbyid",children:"getChatById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatById"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-59",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatwithnoncontacts",children:"getChatWithNonContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatWithNonContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a list of contact with whom the host number has an existing chat who are also not contacts."}),"\n",(0,r.jsx)(s.h4,{id:"returns-60",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatsbylabel",children:"getChatsByLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatsByLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'}),"\n",(0,r.jsx)(s.p,{children:"This method is case insenstive and only works on business host accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-44",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-61",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.h4,{id:"label",children:"Label"}),"\n",(0,r.jsx)(s.p,{children:"The label name"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getcommongroups-insiders",children:["getCommonGroups() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommonGroups"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the groups that you have in common with a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-45",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-62",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadminids",children:"getCommunityAdminIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdminIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admin Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-46",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-63",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadmins",children:"getCommunityAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdmins"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admins as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-64",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityinfo",children:"getCommunityInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityInfo"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns the community metadata. Like group metadata but with a ",(0,r.jsx)(s.code,{children:"subGroups"})," property which is the group metadata of the community subgroups."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-48",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-65",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipantids",children:"getCommunityParticipantIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipantIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-49",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-66",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipants",children:"getCommunityParticipants()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipants"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-50",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-67",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconfig",children:"getConfig()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConfig"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"}),"\n",(0,r.jsx)(s.h4,{id:"returns-68",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconnectionstate",children:"getConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConnectionState"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the connection state"}),"\n",(0,r.jsx)(s.h4,{id:"returns-69",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcontact",children:"getContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getContact"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves contact detail object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-51",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-70",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"geteventsignature",children:"getEventSignature()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getEventSignature"}),"(",(0,r.jsx)(s.code,{children:"simpleListener"}),"?): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-52",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"simpleListener?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-71",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getfeatures",children:"getFeatures()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getFeatures"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."}),"\n",(0,r.jsx)(s.h4,{id:"returns-72",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgenerateduseragent",children:"getGeneratedUserAgent()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGeneratedUserAgent"}),"(",(0,r.jsx)(s.code,{children:"userA"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the generated user agent, this is so you can send it to the decryption module."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-53",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"userA?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-73",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"String useragent of wa-web session"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgptarray",children:"getGptArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGptArray"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"last"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a properly formatted array of messages from to send to the openai api"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-54",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"last"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"10"})]}),"\n",(0,r.jsx)(s.p,{children:"The amount of previous messages to retrieve. Defaults to 10"}),"\n",(0,r.jsx)(s.h4,{id:"returns-74",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupadmins",children:"getGroupAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupAdmins"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get Admins of a Group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-55",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-75",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupapprovalrequests",children:"getGroupApprovalRequests()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupApprovalRequests"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Gets the contact IDs of members requesting approval to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-76",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinfo",children:"getGroupInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInfo"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the title and description of a given group id."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-77",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinvitelink",children:"getGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an invite link for a group chat. returns false if chat is not a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-78",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembers",children:"getGroupMembers()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembers"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns group members [Contact] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-79",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembersid",children:"getGroupMembersId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembersId"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves group members as [Id] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-80",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gethostnumber",children:"getHostNumber()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getHostNumber"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the host device number. Use this number when registering for a license key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-81",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getindicatednewmessages",children:"getIndicatedNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIndicatedNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n'})}),"\n",(0,r.jsx)(s.h4,{id:"returns-82",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getinstanceid",children:"getInstanceId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getInstanceId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the INSTANCE_ID of the current session"}),"\n",(0,r.jsx)(s.h4,{id:"returns-83",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getisplugged",children:"getIsPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIsPlugged"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves whether or not phone is plugged in (i.e on charge)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-84",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getissuelink",children:"getIssueLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIssueLink"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a pre-filled github issue link to easily report a bug"}),"\n",(0,r.jsx)(s.h4,{id:"returns-85",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getkickedgroups",children:"getKickedGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getKickedGroups"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account has been kicked"}),"\n",(0,r.jsx)(s.h4,{id:"returns-86",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastmsgtimestamps",children:"getLastMsgTimestamps()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastMsgTimestamps"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get an array of chatIds with their respective last message's timestamp."}),"\n",(0,r.jsx)(s.p,{children:"This is useful for determining what chats are old/stale and need to be deleted."}),"\n",(0,r.jsx)(s.h4,{id:"returns-87",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastseen",children:"getLastSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsx)(s.li,{children:"They have set it so you cannot see their last seen via privacy settings."}),"\n",(0,r.jsx)(s.li,{children:"You do not have an existing chat with the contact."}),"\n",(0,r.jsx)(s.li,{children:"The chatId is for a group\nIn both of those instances this method will return undefined."}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat."}),"\n",(0,r.jsx)(s.h4,{id:"returns-88",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"number timestamp when chat was last online or undefined."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicenselink",children:"getLicenseLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseLink"}),"(",(0,r.jsx)(s.code,{children:"params"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a license link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-62",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"params?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-89",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicensetype",children:"getLicenseType()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseType"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the the type of license key used by the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-90",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlistenerqueues",children:"getListenerQueues()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getListenerQueues"}),"(): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have set ",(0,r.jsx)(s.code,{children:"onAnyMessage"})," or ",(0,r.jsx)(s.code,{children:"onMessage"})," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-91",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h5,{id:"onack",children:"onAck"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onaddedtogroup",children:"onAddedToGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onanymessage",children:"onAnyMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbattery",children:"onBattery"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbroadcast",children:"onBroadcast"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbutton",children:"onButton"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncallstate",children:"onCallState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatdeleted",children:"onChatDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatopened",children:"onChatOpened"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatstate",children:"onChatState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncontactadded",children:"onContactAdded"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onglobalparticipantschanged",children:"onGlobalParticipantsChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupapprovalrequest",children:"onGroupApprovalRequest"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupchange",children:"onGroupChange"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onincomingcall",children:"onIncomingCall"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlabel",children:"onLabel"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlogout",children:"onLogout"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessage",children:"onMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessagedeleted",children:"onMessageDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onnewproduct",children:"onNewProduct"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onorder",children:"onOrder"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onplugged",children:"onPlugged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onpollvote",children:"onPollVote"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onreaction",children:"onReaction"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onremovedfromgroup",children:"onRemovedFromGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstory",children:"onStory"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getme",children:"getMe()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMe"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with all of your host device details"}),"\n",(0,r.jsx)(s.h4,{id:"returns-92",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagebyid",children:"getMessageById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageById"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves message object of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-63",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-93",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmessageinfo-insiders",children:["getMessageInfo() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageInfo"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Get the detailed message info for a group message sent out by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-64",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message Id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-94",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagereaders",children:"getMessageReaders()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageReaders"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.jsx)(s.code,{children:"t"})," which represents the time at which that contact read the message."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-65",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-95",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmylastmessage",children:"getMyLastMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyLastMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the last message sent by the host account in any given chat or globally."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"This is optional. If no chat Id is set then the last message sent by the host account will be returned."}),"\n",(0,r.jsx)(s.h4,{id:"returns-96",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object or ",(0,r.jsx)(s.code,{children:"undefined"})," if the host account's last message could not be found."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmystatusarray",children:"getMyStatusArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStatusArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-97",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmystoryarray-restricted",children:["getMyStoryArray() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStoryArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all existing stories."}),"\n",(0,r.jsx)(s.p,{children:"Only works with a Story License Key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-98",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getorder-insiders",children:["getOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getOrder"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an order object"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-99",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"order object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpage",children:"getPage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPage"}),"(): ",(0,r.jsx)(s.code,{children:"Page"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-100",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Page"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpolldata",children:"getPollData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPollData"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns poll data including results and votes."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id of the Poll"}),"\n",(0,r.jsx)(s.h4,{id:"returns-101",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprocessstats",children:"getProcessStats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProcessStats"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the stats of the current process and the corresponding browser process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-102",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprofilepicfromserver",children:"getProfilePicFromServer()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProfilePicFromServer"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat picture"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-69",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-103",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Url of the chat picture or undefined if there is no picture for the chat."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessionid",children:"getSessionId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-104",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessioninfo",children:"getSessionInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionInfo"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the session info"}),"\n",(0,r.jsx)(s.h4,{id:"returns-105",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsingleproperty",children:"getSingleProperty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSingleProperty"}),"(",(0,r.jsx)(s.code,{children:"namespace"}),", ",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"property"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."}),"\n",(0,r.jsx)(s.p,{children:"Example - get message read state (ack):"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-70",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"namespace"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:(0,r.jsx)(s.code,{children:"namespace"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"id of the object to get from the specific namespace"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"property"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the single property key to get from the object."}),"\n",(0,r.jsx)(s.h4,{id:"returns-106",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"any If the property or the id cannot be found, it will return a 404"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsnapshot",children:"getSnapshot()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSnapshot"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?, ",(0,r.jsx)(s.code,{children:"width"}),"?, ",(0,r.jsx)(s.code,{children:"height"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a PNG DataURL screenshot of the session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to open before taking a snapshot"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Width of the viewport for the snapshot. Height also required if you want to resize."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Height of the viewport for the snapshot. Width also required if you want to resize."}),"\n",(0,r.jsx)(s.h4,{id:"returns-107",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstarredmessages",children:"getStarredMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStarredMessages"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the starred messages in a given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to filter starred messages by"}),"\n",(0,r.jsx)(s.h4,{id:"returns-108",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstatus",children:"getStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the status of a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["to '",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-109",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"id",children:"id"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"status",children:"status"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"status"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstickerdecryptable",children:(0,r.jsx)(s.del,{children:"getStickerDecryptable()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStickerDecryptable"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["The message ID ",(0,r.jsx)(s.code,{children:"message.id"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-110",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."}),"\n",(0,r.jsx)(s.p,{children:"If you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getstoryviewers-restricted",children:["getStoryViewers() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStoryViewers"}),"(",(0,r.jsx)(s.code,{children:"id"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an array of user ids that have 'read' your story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-75",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The id of the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-111",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gettunnelcode",children:"getTunnelCode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getTunnelCode"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."}),"\n",(0,r.jsx)(s.h4,{id:"returns-112",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunreadmessages",children:"getUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnreadMessages"}),"(",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),", ",(0,r.jsx)(s.code,{children:"use_unread_count"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-76",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"use_unread_count"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-113",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunsentmessages",children:"getUnsentMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnsentMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-114",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getvcards",children:"getVCards()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getVCards"}),"(",(0,r.jsx)(s.code,{children:"msgId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Extracts vcards from a message.This works on messages of typ ",(0,r.jsx)(s.code,{children:"vcard"})," or ",(0,r.jsx)(s.code,{children:"multi_vcard"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"msgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string id of the message to extract the vcards from"}),"\n",(0,r.jsx)(s.h4,{id:"returns-115",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"[vcard]"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{children:'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n'})}),"\n",(0,r.jsx)(s.p,{children:"or false if no valid vcards found."}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.a,{href:"https://www.npmjs.com/package/vcf",children:"vcf"})," to convert a vcard string into a json object"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getwaversion",children:"getWAVersion()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getWAVersion"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-116",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ghostforward",children:"ghostForward()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"ghostForward"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.]\nAny potential abuse of this method will see it become paywalled."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-117",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"healthcheck",children:"healthCheck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"healthCheck"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-118",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"iamadmin",children:"iAmAdmin()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"iAmAdmin"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account is admin"}),"\n",(0,r.jsx)(s.h4,{id:"returns-119",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"inviteinfo",children:"inviteInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"inviteInfo"}),"(",(0,r.jsx)(s.code,{children:"link"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the details of a group through the invite link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-79",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This can be an invite link or invite code"}),"\n",(0,r.jsx)(s.h4,{id:"returns-120",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatmuted",children:"isChatMuted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatMuted"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat is muted"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-80",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat you want to check"}),"\n",(0,r.jsx)(s.h4,{id:"returns-121",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["boolean. ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatonline",children:"isChatOnline()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatOnline"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat contact is online. Not entirely sure if this works with groups."}),"\n",(0,r.jsxs)(s.p,{children:["It will return ",(0,r.jsx)(s.code,{children:"true"})," if the chat is ",(0,r.jsx)(s.code,{children:"online"}),", ",(0,r.jsx)(s.code,{children:"false"})," if the chat is ",(0,r.jsx)(s.code,{children:"offline"}),", ",(0,r.jsx)(s.code,{children:"PRIVATE"})," if the privacy settings of the contact do not allow you to see their status and ",(0,r.jsx)(s.code,{children:"NO_CHAT"})," if you do not currently have a chat with that contact."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-81",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-122",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isconnected",children:"isConnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isConnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves if the phone is online. Please note that this may not be real time."}),"\n",(0,r.jsx)(s.h4,{id:"returns-123",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"isgroupidunsafe-insiders",children:["isGroupIdUnsafe() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isGroupIdUnsafe"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-82",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat you want to deteremine is unsafe"}),"\n",(0,r.jsx)(s.h4,{id:"returns-124",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isPhoneDisconnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:['Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-125",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joingroupvialink",children:"joinGroupViaLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinGroupViaLink"}),"(",(0,r.jsx)(s.code,{children:"link"}),", ",(0,r.jsx)(s.code,{children:"returnChatObj"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Joins a group via the invite link, code, or message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-83",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This param is the string which includes the invite link or code. The following work:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["Follow this link to join my WA group: ",(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})}),"\n",(0,r.jsx)(s.li,{children:"DHTGJUfFJAV9MxOpZO1fBZ"}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have been removed from the group previously, it will return ",(0,r.jsx)(s.code,{children:"401"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"returnChatObj?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata."}),"\n",(0,r.jsx)(s.h4,{id:"returns-126",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," Either false if it didn't work, or the group id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinwebbeta",children:"joinWebBeta()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinWebBeta"}),"(",(0,r.jsx)(s.code,{children:"join"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Join or leave the wa web beta program. Will return true of operation was successful."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-84",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"join"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to join the beta, false to leave"}),"\n",(0,r.jsx)(s.h4,{id:"returns-127",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),"(",(0,r.jsx)(s.code,{children:"reason"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Shuts down the page and browser"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-85",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"reason"}),": ",(0,r.jsx)(s.code,{children:"string"})," = ",(0,r.jsx)(s.code,{children:'"MANUALLY_KILLED"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-128",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"true"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"leavegroup",children:"leaveGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"leaveGroup"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes the host device from the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-86",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-129",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"listwebhooks",children:"listWebhooks()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"listWebhooks"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreives an array of webhook objects"}),"\n",(0,r.jsx)(s.h4,{id:"returns-130",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadallearliermessages",children:"loadAllEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAllEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-87",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-131",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadandgetallmessagesinchat",children:"loadAndGetAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAndGetAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"loads and Retrieves all Messages in a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-88",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-132",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessages",children:"loadEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-89",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-133",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message []"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessagestilldate",children:"loadEarlierMessagesTillDate()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessagesTillDate"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),", ",(0,r.jsx)(s.code,{children:"timestamp"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages until a given timestamp in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-90",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"timestamp"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"in seconds"}),"\n",(0,r.jsx)(s.h4,{id:"returns-134",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logger",children:"logger()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logger"}),"(): ",(0,r.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Grab the logger for this session/process"}),"\n",(0,r.jsx)(s.h4,{id:"returns-135",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"any"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logout",children:"logout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logout"}),"(",(0,r.jsx)(s.code,{children:"preserveSessionData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Logs out from the session."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-91",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"preserveSessionData"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"skip session.data.json file invalidation\nPlease be careful when using this as it can exit the whole process depending on your config"}),"\n",(0,r.jsx)(s.h4,{id:"returns-136",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markallread",children:"markAllRead()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAllRead"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs sendSeen on all chats"}),"\n",(0,r.jsx)(s.h4,{id:"returns-137",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markasunread",children:"markAsUnread()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAsUnread"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to unread. May be useful to get host's attention"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-92",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-138",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"metrics",children:"metrics()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"metrics"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns some metrics of the session/page."}),"\n",(0,r.jsx)(s.h4,{id:"returns-139",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"middleware",children:"middleware()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"middleware"}),"(",(0,r.jsx)(s.code,{children:"useSessionIdInPath"}),", ",(0,r.jsx)(s.code,{children:"PORT"}),"?): (",(0,r.jsx)(s.code,{children:"req"}),", ",(0,r.jsx)(s.code,{children:"res"}),", ",(0,r.jsx)(s.code,{children:"next"}),") => ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n"})}),"\n",(0,r.jsxs)(s.p,{children:["All requests need to be ",(0,r.jsx)(s.code,{children:"POST"})," requests. You use the API the same way you would with ",(0,r.jsx)(s.code,{children:"client"}),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."]}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n"})}),"\n",(0,r.jsx)(s.p,{children:"as a request with a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n"})}),"\n",(0,r.jsx)(s.p,{children:"or as a request without a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n'})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-93",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"useSessionIdInPath"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean Set this to true if you want to keep each session in it's own path."}),"\n",(0,r.jsxs)(s.p,{children:["For example, if you have a session with id ",(0,r.jsx)(s.code,{children:"host"})," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.jsx)(s.code,{children:"host"}),". E.g ",(0,r.jsx)(s.code,{children:"localhost:8082/sendText"})," becomes ",(0,r.jsx)(s.code,{children:"localhost:8082/host/sendText"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"PORT?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-140",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Function"})}),"\n",(0,r.jsx)(s.h5,{id:"parameters-94",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"req"}),": ",(0,r.jsx)(s.code,{children:"Request"}),"<",(0,r.jsx)(s.code,{children:"ParamsDictionary"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"ParsedQs"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"res"}),": ",(0,r.jsx)(s.code,{children:"Response"}),"<",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"next"}),": ",(0,r.jsx)(s.code,{children:"NextFunction"})]}),"\n",(0,r.jsx)(s.h5,{id:"returns-141",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"mutechat-insiders",children:["muteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"muteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"muteDuration"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-95",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation you want to mute"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"muteDuration"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:(0,r.jsx)(s.code,{children:"ChatMuteDuration"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatMuteDuration enum of the time you want this chat to be muted for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-142",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onnewproduct-insiders",children:["onNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-96",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-143",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onorder-insiders",children:["onOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-97",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-144",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"pinchat",children:"pinChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"pinChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"pin"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Pin/Unpin chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-98",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"pin"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-145",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postimagestatus-restricted",children:["postImageStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postImageStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts an image story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-99",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-146",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"posttextstatus-restricted",children:["postTextStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postTextStatus"}),"(",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-100",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"}),"\n4: ",(0,r.jsx)(s.a,{href:"https://www.dafont.com/bebas-neue.font",children:"Bebasneue Regular"}),"\n5: ",(0,r.jsx)(s.a,{href:"https://www.fontsquirrel.com/fonts/oswald",children:"Oswald Heavy"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-147",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postthumbnailstatus-restricted",children:["postThumbnailStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postThumbnailStatus"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story with a thumbnail."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-101",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The URL to share in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 thumbnail override, if not provided the link server will try to figure it out.\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-148",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postvideostatus-restricted",children:["postVideoStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postVideoStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts a video story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-102",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-149",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"prepeventdata",children:"prepEventData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"prepEventData"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"event"}),", ",(0,r.jsx)(s.code,{children:"extras"}),"?): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-103",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"event"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"extras?"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-150",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"promoteparticipant",children:"promoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"promoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Promote Participant to Admin in Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-104",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-151",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"react",children:"react()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"react"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"emoji"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"React to a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-105",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to react to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emoji"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"1 single emoji to add to the message as a reacion"}),"\n",(0,r.jsx)(s.h4,{id:"returns-152",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"refresh",children:"refresh()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"refresh"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"}),"\n",(0,r.jsx)(s.h4,{id:"returns-153",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"registerwebhook",children:"registerWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"registerWebhook"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"events"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"concurrency"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The client can now automatically handle webhooks. Use this method to register webhooks."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-106",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The webhook url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsxs)(s.p,{children:["An array of [[SimpleListener]] enums or ",(0,r.jsx)(s.code,{children:"all"})," (to register all possible listeners)"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"concurrency"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"5"})]}),"\n",(0,r.jsx)(s.p,{children:"the amount of concurrent requests to be handled by the built in queue. Default is 5."}),"\n",(0,r.jsx)(s.h4,{id:"returns-154",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"rejectgroupjoinrequest",children:"rejectGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"rejectGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Rejects a group join request\n*"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-107",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id\n*"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group\n*"}),"\n",(0,r.jsx)(s.h4,{id:"returns-155",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeAllListeners"}),"(): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-156",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelabel",children:"removeLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-108",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-157",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeListener"}),"(",(0,r.jsx)(s.code,{children:"listener"}),"): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"//////////////////////// LISTENERS"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-109",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"listener"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-158",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeparticipant",children:"removeParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove participant of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-110",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"0000000000-00000000@g.us"})}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"000000000000@c.us"})}),"\n",(0,r.jsx)(s.h4,{id:"returns-159",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeproduct",children:"removeProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove a product from the host account's catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-111",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-160",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removewebhook",children:"removeWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes a webhook."}),"\n",(0,r.jsxs)(s.p,{children:["Returns ",(0,r.jsx)(s.code,{children:"true"})," if the webhook was found and removed. ",(0,r.jsx)(s.code,{children:"false"})," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-112",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the webhook"}),"\n",(0,r.jsx)(s.h4,{id:"returns-161",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"retruns",children:"Retruns"}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"reply",children:"reply()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),", ",(0,r.jsx)(s.code,{children:"sendSeen"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-113",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string chatid"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string reply text"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the msg id to reply to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sendSeen?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean If set to true, the chat will 'blue tick' all messages before sending the reply"}),"\n",(0,r.jsx)(s.h4,{id:"returns-162",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," false if didn't work, otherwise returns message id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"reportspam-restricted",children:["reportSpam() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reportSpam"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Report a contact for spam, block them and attempt to clear chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-114",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-163",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"resizepage",children:"resizePage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"resizePage"}),"(",(0,r.jsx)(s.code,{children:"width"}),", ",(0,r.jsx)(s.code,{children:"height"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-115",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1920"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1080"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-164",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"revokegroupinvitelink",children:"revokeGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"revokeGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Revokes the current invite link for a group chat. Any previous links will stop working"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-116",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-165",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendadvancedbuttons",children:(0,r.jsx)(s.del,{children:"sendAdvancedButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAdvancedButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"footer"}),", ",(0,r.jsx)(s.code,{children:"filename"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-117",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:(0,r.jsx)(s.code,{children:"AdvancedButton"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"Required if body is a file!!"}),"\n",(0,r.jsx)(s.h4,{id:"returns-166",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."}),(0,r.jsx)(s.p,{children:"THIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send advanced buttons with media body. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.p,{children:"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendaudio",children:"sendAudio()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAudio"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send an audio file with the default audio player (not PTT/voice message)"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-118",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-167",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbanner",children:"sendBanner()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendBanner"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"base64"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a banner image"}),"\n",(0,r.jsx)(s.p,{children:"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-119",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"base64 encoded jpeg"}),"\n",(0,r.jsx)(s.h4,{id:"returns-168",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbuttons",children:(0,r.jsx)(s.del,{children:"sendButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"title"}),"?, ",(0,r.jsx)(s.code,{children:"footer"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-120",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,r.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title/header of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-169",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-3",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send generic quick reply buttons. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcontact",children:"sendContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendContact"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-121",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-170",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcustomproduct",children:(0,r.jsx)(s.del,{children:"sendCustomProduct()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendCustomProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"productData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-122",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productData"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:(0,r.jsx)(s.code,{children:"CustomProduct"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-171",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-4",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Feature Currently only available with Premium License accounts."}),"\n",(0,r.jsx)(s.p,{children:"Send a custom product to a chat. Please see [[CustomProduct]] for details."}),"\n",(0,r.jsx)(s.p,{children:"Caveats:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"URL will not work (unable to click), you will have to send another message with the URL."}),"\n",(0,r.jsx)(s.li,{children:'Recipient will see a thin banner under picture that says "Something went wrong"'}),"\n",(0,r.jsx)(s.li,{children:"This will only work if you have at least 1 product already in your catalog"}),"\n",(0,r.jsx)(s.li,{children:"Only works on Business accounts"}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendemoji",children:"sendEmoji()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendEmoji"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"emojiId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a discord emoji to a chat as a sticker"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-123",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emojiId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["The discord emoji id without indentifying chars. In discord you would write ",(0,r.jsx)(s.code,{children:":who:"}),", here use ",(0,r.jsx)(s.code,{children:"who"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-172",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfile",children:"sendFile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFile"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"}),"\n",(0,r.jsxs)(s.p,{children:["Please note that any file that resolves to mime-type ",(0,r.jsx)(s.code,{children:"octet-stream"})," will, by default, resolve to an MP4 file."]}),"\n",(0,r.jsxs)(s.p,{children:["If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.jsx)(s.a,{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",children:"https://www.iana.org/assignments/media-types/media-types.xhtml"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-124",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string xxxxx With an ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"INSIDERS LICENSE-KEY"})," you can also tag people in groups with ",(0,r.jsx)(s.code,{children:"@[number]"}),". For example if you want to mention the user with the number ",(0,r.jsx)(s.code,{children:"44771234567"}),", just add ",(0,r.jsx)(s.code,{children:"@44771234567"})," in the caption."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-173",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfilefromurl",children:"sendFileFromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFileFromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file by Url or custom options"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-125",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string 'video.mp4'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-174",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphy",children:"sendGiphy()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphy"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-126",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif",children:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"})," => ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsx)(s.h4,{id:"returns-175",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphyassticker",children:"sendGiphyAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphyAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a giphy GIF as an animated sticker."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-127",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"URL"})]}),"\n",(0,r.jsxs)(s.p,{children:["URL | string This is the giphy media url and has to be in the format ",(0,r.jsx)(s.code,{children:"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif"})," or it can be just the id ",(0,r.jsx)(s.code,{children:"RJKHjCAdsAfQPn03qQ"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-176",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimage",children:"sendImage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a image to given chat, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-128",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-177",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimageassticker",children:"sendImageAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-129",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-178",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendimageasstickerasreply-insiders",children:["sendImageAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image and sends it as a sticker to the recipient as a reply to another message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-130",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.p,{children:"Sticker metadata"}),"\n",(0,r.jsx)(s.h4,{id:"returns-179",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimagewithproduct",children:"sendImageWithProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageWithProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"bizNumber"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends product with image to chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-131",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the caption you want to add to this message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"bizNumber"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the @c.us number of the business account from which you want to grab the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string the id of the product within the main catalog of the aforementioned business"}),"\n",(0,r.jsx)(s.h4,{id:"returns-180",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlinkwithautopreview",children:"sendLinkWithAutoPreview()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLinkWithAutoPreview"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),"?, ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-132",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-181",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlistmessage",children:(0,r.jsx)(s.del,{children:"sendListMessage()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendListMessage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"sections"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"actionText"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-133",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sections"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,r.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The Sections of rows for the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The description of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"actionText"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The action text of the list message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-182",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-5",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."}),(0,r.jsx)(s.p,{children:"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE"})]}),"\n",(0,r.jsx)(s.p,{children:"Send a list message. This will not work when being sent from business accounts!"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlocation",children:"sendLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLocation"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"lat"}),", ",(0,r.jsx)(s.code,{children:"lng"}),", ",(0,r.jsx)(s.code,{children:"loc"}),", ",(0,r.jsx)(s.code,{children:"address"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Note: ",(0,r.jsx)(s.code,{children:"address"})," and ",(0,r.jsx)(s.code,{children:"url"})," are parameters available to insiders only."]}),"\n",(0,r.jsx)(s.p,{children:"Sends a location message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-134",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lat"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"latitude: '51.5074'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lng"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"longitude: '0.1278'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"loc"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"location text: 'LONDON!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"address?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"address text: '1 Regents Park!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["address text link: '",(0,r.jsx)(s.a,{href:"https://example.com",children:"https://example.com"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-183",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmessagewiththumb",children:"sendMessageWithThumb()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMessageWithThumb"}),"(",(0,r.jsx)(s.code,{children:"thumb"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a link to a chat that includes a link preview."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-135",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumb"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The link you want to send"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the link"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The long description of the link preview"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat you want to send this message to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-184",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmp4assticker",children:"sendMp4AsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMp4AsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"processOptions"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?, ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-136",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsx)(s.p,{children:"[[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"processOptions"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,r.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})," = ",(0,r.jsx)(s.code,{children:"defaultProcessOptions"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-185",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendmultiplecontacts-insiders",children:["sendMultipleContacts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMultipleContacts"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactIds"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends multiple contacts as a single message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-137",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactIds"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-186",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpaymentrequest",children:"sendPaymentRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPaymentRequest"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"amount"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[UNTESTED - REQUIRES FEEDBACK]\nSends a payment request message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-138",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"amount"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number the amount to request in 1000 format (e.g \xa310 => 10000)"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The 3 letter currency code"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string optional message to send with the payment request"}),"\n",(0,r.jsx)(s.h4,{id:"returns-187",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpoll",children:"sendPoll()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPoll"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"options"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"allowMultiSelect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a poll to a group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-139",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id - a group chat is required"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the name of the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"an array of poll options"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"A message to quote when sending the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"allowMultiSelect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not to allow multiple selections. default false"}),"\n",(0,r.jsx)(s.h4,{id:"returns-188",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendproduct-insiders",children:["sendProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendProduct"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Send a product to a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-140",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-189",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"MessageID"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendptt",children:"sendPtt()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPtt"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-141",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 data",":image","/xxx;base64,xxx or the path of the file you want to send."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-190",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendrawwebpassticker",children:"sendRawWebpAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-142",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-191",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendrawwebpasstickerasreply-insiders",children:["sendRawWebpAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-143",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"MessageId Message ID of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-192",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendreplywithmentions",children:"sendReplyWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendReplyWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"replyMessageId"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-144",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"replyMessageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-193",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendseen",children:"sendSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to seen. Marks all messages as ack: 3"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-145",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-194",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendstickerfromurl",children:"sendStickerfromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker (including GIF) from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-146",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-195",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendstickerfromurlasreply-insiders",children:["sendStickerfromUrlAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrlAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-147",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the image"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-196",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendtext-restricted",children:["sendText() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendText"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a text message to given chat"}),"\n",(0,r.jsxs)(s.p,{children:["A license is ",(0,r.jsx)(s.strong,{children:"NOT"})," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-148",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-197",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendtextwithmentions",children:"sendTextWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendTextWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-149",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-198",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvcard",children:"sendVCard()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVCard"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"vcard"}),", ",(0,r.jsx)(s.code,{children:"contactName"}),"?, ",(0,r.jsx)(s.code,{children:"contactNumber"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send VCARD"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-150",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"vcard"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"vcard as a string, you can send multiple contacts vcard also."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactName?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The display name for the contact. Ignored on multiple vcards"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactNumber?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g:\n",(0,r.jsx)(s.code,{children:"4477777777777"}),"\nIgnored on multiple vcards"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-199",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvideoasgif",children:"sendVideoAsGif()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVideoAsGif"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-151",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-200",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendyoutubelink",children:"sendYoutubeLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendYoutubeLink"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-152",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A youtube link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})," = ",(0,r.jsx)(s.code,{children:"''"})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-201",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatbackgroundcolourhex-insiders",children:["setChatBackgroundColourHex() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatBackgroundColourHex"}),"(",(0,r.jsx)(s.code,{children:"hex"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Set the wallpaper background colour"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-153",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hex"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"'#FFF123'"}),"\n",(0,r.jsx)(s.h4,{id:"returns-202",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatephemeral-insiders",children:["setChatEphemeral() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatEphemeral"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"ephemeral"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Turn the ephemeral setting in a chat to on or off"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-154",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the chat"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ephemeral"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:(0,r.jsx)(s.code,{children:"EphemeralDuration"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," to turn on the ephemeral setting to 1 day, ",(0,r.jsx)(s.code,{children:"false"})," to turn off the ephemeral setting. Other options: ",(0,r.jsx)(s.code,{children:"604800 | 7776000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-203",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true if the setting was set, ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setchatstate",children:"setChatState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatState"}),"(",(0,r.jsx)(s.code,{children:"chatState"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the chat state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-155",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatState"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:(0,r.jsx)(s.code,{children:"ChatState"})})]}),"\n",(0,r.jsx)(s.p,{children:"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2)."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-204",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupapprovalmode",children:"setGroupApprovalMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupApprovalMode"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"requireApproval"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Turn on or off the approval requirement for new members to join a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-156",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requireApproval"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"set to true to turn on the approval requirement, false to turn off"}),"\n",(0,r.jsx)(s.h4,{id:"returns-205",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupdescription",children:"setGroupDescription()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupDescription"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"description"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the group chant description"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-157",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group description"}),"\n",(0,r.jsx)(s.h4,{id:"returns-206",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupedittoadminsonly",children:"setGroupEditToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupEditToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot edit a groups details"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-158",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-207",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupicon",children:"setGroupIcon()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIcon"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"image"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-159",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-208",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupiconbyurl",children:"setGroupIconByUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIconByUrl"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-160",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-209",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setgrouptitle-insiders",children:["setGroupTitle() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupTitle"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"title"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Change the group chat title"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-161",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group title"}),"\n",(0,r.jsx)(s.h4,{id:"returns-210",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgrouptoadminsonly",children:"setGroupToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot speak in a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-162",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-211",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmyname",children:"setMyName()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyName"}),"(",(0,r.jsx)(s.code,{children:"newName"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set your profile name"}),"\n",(0,r.jsx)(s.p,{children:"Please note, this does not work on business accounts!"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-163",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new name to set for your profile"}),"\n",(0,r.jsx)(s.h4,{id:"returns-212",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmystatus",children:"setMyStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyStatus"}),"(",(0,r.jsx)(s.code,{children:"newStatus"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"set your about me"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-164",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newStatus"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new profile status"}),"\n",(0,r.jsx)(s.h4,{id:"returns-213",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setpresence",children:"setPresence()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setPresence"}),"(",(0,r.jsx)(s.code,{children:"available"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set presence to available or unavailable."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-165",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"available"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);"}),"\n",(0,r.jsx)(s.h4,{id:"returns-214",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setprofilepic",children:"setProfilePic()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setProfilePic"}),"(",(0,r.jsx)(s.code,{children:"data"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the profile pic of the host number."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-166",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"string data url image string."}),"\n",(0,r.jsx)(s.h4,{id:"returns-215",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," success if true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulaterecording",children:"simulateRecording()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateRecording"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...recording' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-167",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated recording, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-216",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulatetyping",children:"simulateTyping()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateTyping"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...typing' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-168",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated typing, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-217",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"starmessage",children:"starMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"starMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Star a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-169",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to star"}),"\n",(0,r.jsx)(s.h4,{id:"returns-218",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"synccontacts",children:"syncContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"syncContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Syncs contacts with phone. This promise does not resolve so it will instantly return true."}),"\n",(0,r.jsx)(s.h4,{id:"returns-219",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"tageveryone-insiders",children:["tagEveryone() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"tagEveryone"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"formatting"}),"?, ",(0,r.jsx)(s.code,{children:"messageBeforeTags"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Tags everyone in the group with a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-170",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@g.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message to add under all of the tags"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"formatting?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The formatting of the tags. Use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageBeforeTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["set to ",(0,r.jsx)(s.code,{children:"true"})," to show the message before all of the tags"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-220",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.h4,{id:"mention",children:"Mention"}),"\n",(0,r.jsx)(s.p,{children:"to indicate the actual tag."}),"\n",(0,r.jsx)(s.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"@mention "})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testbuttons",children:(0,r.jsx)(s.del,{children:"testButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testButtons"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-171",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-221",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-6",children:"Deprecated"}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testcallback",children:"testCallback()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testCallback"}),"(",(0,r.jsx)(s.code,{children:"callbackToTest"}),", ",(0,r.jsx)(s.code,{children:"testData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this simple command to test firing callback events."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-172",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"callbackToTest"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"testData"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-222",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if the callback was not registered/does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"unmutechat-insiders",children:["unmuteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unmuteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Unmutes a conversation."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-173",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-223",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"unstarmessage",children:"unstarMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unstarMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unstar a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-174",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to unstar"}),"\n",(0,r.jsx)(s.h4,{id:"returns-224",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"updatewebhook",children:"updateWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"updateWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),", ",(0,r.jsx)(s.code,{children:"events"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]]."}),"\n",(0,r.jsx)(s.p,{children:"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-175",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-225",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitallqempty",children:"waitAllQEmpty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitAllQEmpty"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for all queues to be empty"}),"\n",(0,r.jsx)(s.h4,{id:"returns-226",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitwhqidle",children:"waitWhQIdle()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitWhQIdle"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-227",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"events",children:"Events"}),"\n",(0,r.jsx)(s.h3,{id:"onack-1",children:"onAck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to messages acknowledgement Changes"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-176",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-228",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onaddedtogroup-1",children:"onAddedToGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is added to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-177",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-229",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onanymessage-1",children:"onAnyMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all new messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-178",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-230",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbattery-1",children:(0,r.jsx)(s.del,{children:"onBattery()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-179",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-231",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-7",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Listens to battery changes"}),"\n",(0,r.jsx)(s.admonition,{type:"caution",children:(0,r.jsx)(s.p,{children:"This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers."})}),"\n",(0,r.jsx)(s.h4,{id:"fires-1",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbroadcast-1",children:"onBroadcast()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to broadcast messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-180",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-232",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-2",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbutton-1",children:"onButton()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to button message responses"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-181",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-233",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-3",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"oncallstate-1",children:"onCallState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes on call state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-182",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-234",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onchatdeleted-1",children:"onChatDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a chat is deleted by the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-183",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-235",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-4",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Chat]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatopened-insiders",children:["onChatOpened() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-184",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ChatId]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-236",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatstate-insiders",children:["onChatState() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to chat state, including when a specific user is recording and typing within a group chat."}),"\n",(0,r.jsx)(s.p,{children:"Here is an example of the fired object:"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-185",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-237",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-5",children:"Fires"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n'})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"oncontactadded-insiders",children:["onContactAdded() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with contact id when a new contact is added on the host phone."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-186",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-238",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onglobalparticipantschanged-1",children:"onGlobalParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-187",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-239",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupapprovalrequest-1",children:"onGroupApprovalRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Listents to group approval requests. Emits a message object. Use it with ",(0,r.jsx)(s.code,{children:"message.isGroupApprovalRequest()"})," to check if it is a group approval request."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-188",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-240",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupchange-1",children:"onGroupChange()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-189",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-241",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onincomingcall-1",children:"onIncomingCall()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to new incoming calls"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-190",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-242",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call request objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlabel-1",children:"onLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to label change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-191",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-243",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-6",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Label]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlivelocation",children:"onLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to live locations from a chat that already has valid live locations"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-192",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"the chat from which you want to subscribes to live location updates"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback that takes in a LiveLocationChangedEvent"}),"\n",(0,r.jsx)(s.h4,{id:"returns-244",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean, if returns false then there were no valid live locations in the chat of chatId"}),"\n",(0,r.jsx)(s.h4,{id:"emits",children:"Emits"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:""})," LiveLocationChangedEvent"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlogout-1",children:"onLogout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"priority"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to a log out event"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-193",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"priority?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks"}),"\n",(0,r.jsx)(s.h4,{id:"returns-245",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-7",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessage-1",children:"onMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to incoming messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-194",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-246",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-8",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessagedeleted-1",children:"onMessageDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a message is deleted by a recipient or the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-195",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-247",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-9",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onparticipantschanged",children:"onParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"legacy"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-196",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group id: ",(0,r.jsx)(s.a,{href:"mailto:xxxxx-yyyy@c.us",children:"xxxxx-yyyy@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"legacy"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-248",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of participantChangedEvent"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onplugged-1",children:"onPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when host device is plugged/unplugged"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-197",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-249",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-10",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"boolean true if plugged, false if unplugged"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onpollvote-1",children:"onPollVote()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to poll vote events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-198",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-250",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-11",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[PollData]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onreaction-insiders",children:["onReaction() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to reaction add and change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-199",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-251",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-12",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[ReactionEvent]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onremovedfromgroup-insiders",children:["onRemovedFromGroup() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is removed to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-200",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-252",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onstatechanged-1",children:"onStateChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes in state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-201",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-253",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-13",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"STATE observable sream of states"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onstory-restricted",children:["onStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a contact posts a new story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-202",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-254",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-14",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"e.g"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>c});var r=n(6540);const i={},d=r.createContext(i);function l(e){const s=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/27075183.6463c901.js b/assets/js/27075183.6463c901.js deleted file mode 100644 index d193ccdbe0..0000000000 --- a/assets/js/27075183.6463c901.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4332],{3775:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=r(4848),s=r(8453);const t={},i="Enumeration: OnError",c={id:"reference/api/model/config/enumerations/OnError",title:"Enumeration: OnError",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/OnError.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/OnError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage"},next:{title:"Enumeration: QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat"}},l={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AS_STRING",id:"as_string",level:3},{value:"LOG_AND_FALSE",id:"log_and_false",level:3},{value:"LOG_AND_STRING",id:"log_and_string",level:3},{value:"NOTHING",id:"nothing",level:3},{value:"RETURN_ERROR",id:"return_error",level:3},{value:"RETURN_FALSE",id:"return_false",level:3},{value:"THROW",id:"throw",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"enumeration-onerror",children:"Enumeration: OnError"}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"as_string",children:"AS_STRING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AS_STRING"}),": ",(0,o.jsx)(n.code,{children:'"AS_STRING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Return it as a string"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"log_and_false",children:"LOG_AND_FALSE"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"LOG_AND_FALSE"}),": ",(0,o.jsx)(n.code,{children:'"LOG_AND_FALSE"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Log the error and return false"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"log_and_string",children:"LOG_AND_STRING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"LOG_AND_STRING"}),": ",(0,o.jsx)(n.code,{children:'"LOG_AND_STRING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Log the error AND return the string"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"nothing",children:"NOTHING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"NOTHING"}),": ",(0,o.jsx)(n.code,{children:'"NOTHING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Do nothing."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"return_error",children:"RETURN_ERROR"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"RETURN_ERROR"}),": ",(0,o.jsx)(n.code,{children:'"RETURN_ERROR"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Return the error object"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"return_false",children:"RETURN_FALSE"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"RETURN_FALSE"}),": ",(0,o.jsx)(n.code,{children:'"RETURN_FALSE"'})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Do not log anything, just return ",(0,o.jsx)(n.code,{children:"false"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"throw",children:"THROW"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"THROW"}),": ",(0,o.jsx)(n.code,{children:'"THROW"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"throw the error"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var o=r(6540);const s={},t=o.createContext(s);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/27075183.92347087.js b/assets/js/27075183.92347087.js new file mode 100644 index 0000000000..4af0744177 --- /dev/null +++ b/assets/js/27075183.92347087.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4332],{3775:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=r(4848),s=r(8453);const t={},i="Enumeration: OnError",c={id:"reference/api/model/config/enumerations/OnError",title:"Enumeration: OnError",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/OnError.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/OnError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage"},next:{title:"Enumeration: QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat"}},l={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AS_STRING",id:"as_string",level:3},{value:"LOG_AND_FALSE",id:"log_and_false",level:3},{value:"LOG_AND_STRING",id:"log_and_string",level:3},{value:"NOTHING",id:"nothing",level:3},{value:"RETURN_ERROR",id:"return_error",level:3},{value:"RETURN_FALSE",id:"return_false",level:3},{value:"THROW",id:"throw",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"enumeration-onerror",children:"Enumeration: OnError"})}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"as_string",children:"AS_STRING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AS_STRING"}),": ",(0,o.jsx)(n.code,{children:'"AS_STRING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Return it as a string"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"log_and_false",children:"LOG_AND_FALSE"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"LOG_AND_FALSE"}),": ",(0,o.jsx)(n.code,{children:'"LOG_AND_FALSE"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Log the error and return false"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"log_and_string",children:"LOG_AND_STRING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"LOG_AND_STRING"}),": ",(0,o.jsx)(n.code,{children:'"LOG_AND_STRING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Log the error AND return the string"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"nothing",children:"NOTHING"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"NOTHING"}),": ",(0,o.jsx)(n.code,{children:'"NOTHING"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Do nothing."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"return_error",children:"RETURN_ERROR"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"RETURN_ERROR"}),": ",(0,o.jsx)(n.code,{children:'"RETURN_ERROR"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Return the error object"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"return_false",children:"RETURN_FALSE"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"RETURN_FALSE"}),": ",(0,o.jsx)(n.code,{children:'"RETURN_FALSE"'})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Do not log anything, just return ",(0,o.jsx)(n.code,{children:"false"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"throw",children:"THROW"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"THROW"}),": ",(0,o.jsx)(n.code,{children:'"THROW"'})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"throw the error"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var o=r(6540);const s={},t=o.createContext(s);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/279c9f30.0b9ae964.js b/assets/js/279c9f30.0b9ae964.js new file mode 100644 index 0000000000..0b0af4e1d2 --- /dev/null +++ b/assets/js/279c9f30.0b9ae964.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5626],{6691:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=o(4848),t=o(8453);const s={},i="Variable: log",c={id:"reference/logging/logging/variables/log",title:"Variable: log",description:"const log: Logger",source:"@site/docs/reference/logging/logging/variables/log.md",sourceDirName:"reference/logging/logging/variables",slug:"/reference/logging/logging/variables/log",permalink:"/docs/reference/logging/logging/variables/log",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/variables/log.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport"},next:{title:"structures/Collector",permalink:"/docs/reference/structures/Collector/"}},a={},l=[];function g(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"variable-log",children:"Variable: log"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"log"}),": ",(0,r.jsx)(n.code,{children:"Logger"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["You can access the log in your code and add your own custom transports\n",(0,r.jsx)(n.a,{href:"https://github.com/winstonjs/winston#transports",children:"https://github.com/winstonjs/winston#transports"}),"\nsee ",(0,r.jsx)(n.a,{href:"https://github.com/winstonjs/winston#transports",children:"Logger"})," for more details."]}),"\n",(0,r.jsx)(n.p,{children:"Here is an example of adding the GCP stackdriver transport:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"import { log } from '@open-wa/wa-automate'\nimport { LoggingWinston } from '@google-cloud/logging-winston';\n\nconst gcpTransport = new LoggingWinston({\n projectId: 'your-project-id',\n keyFilename: '/path/to/keyfile.json'\n });\n\n...\nlog.add(\n gcpTransport\n)\n\n//Congrats! Now all of your session logs will also go to GCP Stackdriver\n"})})]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(g,{...e})}):g(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>c});var r=o(6540);const t={},s=r.createContext(t);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/279c9f30.858834f2.js b/assets/js/279c9f30.858834f2.js deleted file mode 100644 index 8ddc342c75..0000000000 --- a/assets/js/279c9f30.858834f2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5626],{6691:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>g,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=o(4848),t=o(8453);const s={},i="Variable: log",c={id:"reference/logging/logging/variables/log",title:"Variable: log",description:"const log: Logger",source:"@site/docs/reference/logging/logging/variables/log.md",sourceDirName:"reference/logging/logging/variables",slug:"/reference/logging/logging/variables/log",permalink:"/docs/reference/logging/logging/variables/log",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/variables/log.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport"},next:{title:"structures/Collector",permalink:"/docs/reference/structures/Collector/"}},g={},l=[];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-log",children:"Variable: log"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"log"}),": ",(0,r.jsx)(n.code,{children:"Logger"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["You can access the log in your code and add your own custom transports\n",(0,r.jsx)(n.a,{href:"https://github.com/winstonjs/winston#transports",children:"https://github.com/winstonjs/winston#transports"}),"\nsee ",(0,r.jsx)(n.a,{href:"https://github.com/winstonjs/winston#transports",children:"Logger"})," for more details."]}),"\n",(0,r.jsx)(n.p,{children:"Here is an example of adding the GCP stackdriver transport:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"import { log } from '@open-wa/wa-automate'\nimport { LoggingWinston } from '@google-cloud/logging-winston';\n\nconst gcpTransport = new LoggingWinston({\n projectId: 'your-project-id',\n keyFilename: '/path/to/keyfile.json'\n });\n\n...\nlog.add(\n gcpTransport\n)\n\n//Congrats! Now all of your session logs will also go to GCP Stackdriver\n"})})]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>c});var r=o(6540);const t={},s=r.createContext(t);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28a4b851.9461032a.js b/assets/js/28a4b851.9461032a.js deleted file mode 100644 index 58d3876813..0000000000 --- a/assets/js/28a4b851.9461032a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2166],{9820:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>r});var o=t(4848),c=t(8453);const l={},a="Handle Incoming Call",s={id:"how-to/incoming-calls",title:"Handle Incoming Call",description:"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number",source:"@site/docs/how-to/incoming-calls.md",sourceDirName:"how-to",slug:"/how-to/incoming-calls",permalink:"/docs/how-to/incoming-calls",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/incoming-calls.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Error Handling",permalink:"/docs/how-to/handle-errors"},next:{title:"Location",permalink:"/docs/how-to/location"}},i={},r=[];function d(e){const n={code:"code",h1:"h1",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"handle-incoming-call",children:"Handle Incoming Call"}),"\n",(0,o.jsx)(n.p,{children:"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" client.onIncomingCall(async call=>{\n await client.sendText(call.peerJid._serialized, 'Sorry I cannot accept calls');\n });\n"})})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>s});var o=t(6540);const c={},l=o.createContext(c);function a(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28a4b851.f353467f.js b/assets/js/28a4b851.f353467f.js new file mode 100644 index 0000000000..27f1f79924 --- /dev/null +++ b/assets/js/28a4b851.f353467f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2166],{9820:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>i});var o=t(4848),c=t(8453);const l={},a="Handle Incoming Call",s={id:"how-to/incoming-calls",title:"Handle Incoming Call",description:"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number",source:"@site/docs/how-to/incoming-calls.md",sourceDirName:"how-to",slug:"/how-to/incoming-calls",permalink:"/docs/how-to/incoming-calls",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/incoming-calls.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Error Handling",permalink:"/docs/how-to/handle-errors"},next:{title:"Location",permalink:"/docs/how-to/location"}},r={},i=[];function d(e){const n={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"handle-incoming-call",children:"Handle Incoming Call"})}),"\n",(0,o.jsx)(n.p,{children:"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" client.onIncomingCall(async call=>{\n await client.sendText(call.peerJid._serialized, 'Sorry I cannot accept calls');\n });\n"})})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>s});var o=t(6540);const c={},l=o.createContext(c);function a(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29a49838.182e5429.js b/assets/js/29a49838.182e5429.js deleted file mode 100644 index 5cca604950..0000000000 --- a/assets/js/29a49838.182e5429.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3177],{412:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var n=t(4848),r=t(8453);const o={},c="Interface: CollectorOptions",l={id:"reference/structures/Collector/interfaces/CollectorOptions",title:"Interface: CollectorOptions",description:"Options to be applied to the collector.",source:"@site/docs/reference/structures/Collector/interfaces/CollectorOptions.md",sourceDirName:"reference/structures/Collector/interfaces",slug:"/reference/structures/Collector/interfaces/CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/interfaces/CollectorOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions"},next:{title:"Type Alias: CollectorFilter()\\",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter"}},i={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose?",id:"dispose",level:3},{value:"idle?",id:"idle",level:3},{value:"max?",id:"max",level:3},{value:"maxProcessed?",id:"maxprocessed",level:3},{value:"time?",id:"time",level:3}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"interface-collectoroptions",children:"Interface: CollectorOptions"}),"\n",(0,n.jsx)(s.p,{children:"Options to be applied to the collector."}),"\n",(0,n.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,n.jsx)(s.code,{children:"AwaitMessagesOptions"})})}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"dispose",children:"dispose?"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"optional"})," ",(0,n.jsx)(s.strong,{children:"dispose"}),": ",(0,n.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Whether to dispose data when it's deleted"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"idle",children:"idle?"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"optional"})," ",(0,n.jsx)(s.strong,{children:"idle"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Max time allowed idle"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"max",children:"max?"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"optional"})," ",(0,n.jsx)(s.strong,{children:"max"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The maximum amount of items to collect"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"maxprocessed",children:"maxProcessed?"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"optional"})," ",(0,n.jsx)(s.strong,{children:"maxProcessed"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The maximum amount of items to process"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"time",children:"time?"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"optional"})," ",(0,n.jsx)(s.strong,{children:"time"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Max time to wait for items in milliseconds"})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>c,x:()=>l});var n=t(6540);const r={},o=n.createContext(r);function c(e){const s=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29a49838.d5ac135d.js b/assets/js/29a49838.d5ac135d.js new file mode 100644 index 0000000000..0341c23965 --- /dev/null +++ b/assets/js/29a49838.d5ac135d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3177],{412:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var r=t(4848),n=t(8453);const o={},c="Interface: CollectorOptions",l={id:"reference/structures/Collector/interfaces/CollectorOptions",title:"Interface: CollectorOptions",description:"Options to be applied to the collector.",source:"@site/docs/reference/structures/Collector/interfaces/CollectorOptions.md",sourceDirName:"reference/structures/Collector/interfaces",slug:"/reference/structures/Collector/interfaces/CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/interfaces/CollectorOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions"},next:{title:"Type Alias: CollectorFilter()\\",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter"}},i={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose?",id:"dispose",level:3},{value:"idle?",id:"idle",level:3},{value:"max?",id:"max",level:3},{value:"maxProcessed?",id:"maxprocessed",level:3},{value:"time?",id:"time",level:3}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"interface-collectoroptions",children:"Interface: CollectorOptions"})}),"\n",(0,r.jsx)(s.p,{children:"Options to be applied to the collector."}),"\n",(0,r.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,r.jsx)(s.code,{children:"AwaitMessagesOptions"})})}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"dispose",children:"dispose?"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"optional"})," ",(0,r.jsx)(s.strong,{children:"dispose"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Whether to dispose data when it's deleted"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"idle",children:"idle?"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"optional"})," ",(0,r.jsx)(s.strong,{children:"idle"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Max time allowed idle"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"max",children:"max?"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"optional"})," ",(0,r.jsx)(s.strong,{children:"max"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The maximum amount of items to collect"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"maxprocessed",children:"maxProcessed?"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"optional"})," ",(0,r.jsx)(s.strong,{children:"maxProcessed"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The maximum amount of items to process"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"time",children:"time?"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"optional"})," ",(0,r.jsx)(s.strong,{children:"time"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Max time to wait for items in milliseconds"})]})}function h(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>c,x:()=>l});var r=t(6540);const n={},o=r.createContext(n);function c(e){const s=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29b289c3.2ae081f3.js b/assets/js/29b289c3.2ae081f3.js new file mode 100644 index 0000000000..e4faf617d1 --- /dev/null +++ b/assets/js/29b289c3.2ae081f3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[747],{3214:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>l,toc:()=>o});var r=i(4848),c=i(8453);const s={},d="Type Alias: StickerMetadata",l={id:"reference/api/model/media/type-aliases/StickerMetadata",title:"Type Alias: StickerMetadata",description:"StickerMetadata: object",source:"@site/docs/reference/api/model/media/type-aliases/StickerMetadata.md",sourceDirName:"reference/api/model/media/type-aliases",slug:"/reference/api/model/media/type-aliases/StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/type-aliases/StickerMetadata.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions"},next:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"}},t={},o=[{value:"Type declaration",id:"type-declaration",level:2},{value:"author",id:"author",level:3},{value:"Default",id:"default",level:4},{value:"circle?",id:"circle",level:3},{value:"cornerRadius?",id:"cornerradius",level:3},{value:"Default",id:"default-1",level:4},{value:"Minimum",id:"minimum",level:4},{value:"Maximum",id:"maximum",level:4},{value:"Multiple Of",id:"multiple-of",level:4},{value:"cropPosition?",id:"cropposition",level:3},{value:"Default",id:"default-2",level:4},{value:"discord?",id:"discord",level:3},{value:"keepScale?",id:"keepscale",level:3},{value:"pack",id:"pack",level:3},{value:"Default",id:"default-3",level:4},{value:"removebg?",id:"removebg",level:3},{value:"Default",id:"default-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"type-alias-stickermetadata",children:"Type Alias: StickerMetadata"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"StickerMetadata"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"author",children:"author"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"author"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The author of the sticker"}),"\n",(0,r.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"``\n"})}),"\n",(0,r.jsx)(n.h3,{id:"circle",children:"circle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"circle"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Applies a circular mask to the sticker. Works on images only for now."}),"\n",(0,r.jsx)(n.h3,{id:"cornerradius",children:"cornerRadius?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cornerRadius"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The corner radius of the sticker when ",(0,r.jsx)(n.code,{children:"stickerMetadata.circle"})," is set to true."]}),"\n",(0,r.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"100"})}),"\n",(0,r.jsx)(n.h4,{id:"minimum",children:"Minimum"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"1"})}),"\n",(0,r.jsx)(n.h4,{id:"maximum",children:"Maximum"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"100"})}),"\n",(0,r.jsx)(n.h4,{id:"multiple-of",children:"Multiple Of"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"1"})}),"\n",(0,r.jsx)(n.h3,{id:"cropposition",children:"cropPosition?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cropPosition"}),": ",(0,r.jsx)(n.code,{children:'"top"'})," | ",(0,r.jsx)(n.code,{children:'"right top"'})," | ",(0,r.jsx)(n.code,{children:'"right"'})," | ",(0,r.jsx)(n.code,{children:'"right bottom"'})," | ",(0,r.jsx)(n.code,{children:'"bottom"'})," | ",(0,r.jsx)(n.code,{children:'"left bottom"'})," | ",(0,r.jsx)(n.code,{children:'"left"'})," | ",(0,r.jsx)(n.code,{children:'"left top"'})," | ",(0,r.jsx)(n.code,{children:'"north"'})," | ",(0,r.jsx)(n.code,{children:'"northeast"'})," | ",(0,r.jsx)(n.code,{children:'"east"'})," | ",(0,r.jsx)(n.code,{children:'"southeast"'})," | ",(0,r.jsx)(n.code,{children:'"south"'})," | ",(0,r.jsx)(n.code,{children:'"southwest"'})," | ",(0,r.jsx)(n.code,{children:'"west"'})," | ",(0,r.jsx)(n.code,{children:'"northwest"'})," | ",(0,r.jsx)(n.code,{children:'"center"'})," | ",(0,r.jsx)(n.code,{children:'"centre"'})," | ",(0,r.jsx)(n.code,{children:'"entropy"'})," | ",(0,r.jsx)(n.code,{children:'"attention"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Crop position"}),"\n",(0,r.jsxs)(n.p,{children:["Learn more: ",(0,r.jsx)(n.a,{href:"https://sharp.pixelplumbing.com/api-resize",children:"https://sharp.pixelplumbing.com/api-resize"})]}),"\n",(0,r.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"attention"})}),"\n",(0,r.jsx)(n.h3,{id:"discord",children:"discord?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"discord"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Your Discord ID to get onto the sticker leaderboard!"}),"\n",(0,r.jsx)(n.h3,{id:"keepscale",children:"keepScale?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"keepScale"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Setting this to ",(0,r.jsx)(n.code,{children:"true"})," will skip the resizing/square-cropping of the sticker. It will instead 'letterbox' the image with a transparent background."]}),"\n",(0,r.jsx)(n.h3,{id:"pack",children:"pack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"pack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The pack of the sticker"}),"\n",(0,r.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"``\n"})}),"\n",(0,r.jsx)(n.h3,{id:"removebg",children:"removebg?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"removebg"}),": ",(0,r.jsx)(n.code,{children:"boolean"})," | ",(0,r.jsx)(n.code,{children:'"HQ"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"ALPHA FEATURE - NO GUARANTEES IT WILL WORK AS EXPECTED:"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"REQUIRES AN INSIDERS LICENSE-KEY"})}),"\n",(0,r.jsx)(n.p,{children:"Attempt to remove the background of the sticker. Only valid for paid licenses."}),"\n",(0,r.jsx)(n.p,{children:"options:"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," - remove background after resizing"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"HQ"})," - remove background before resizing (i.e on original photo)"]}),"\n",(0,r.jsx)(n.h4,{id:"default-4",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"false"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>l});var r=i(6540);const c={},s=r.createContext(c);function d(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29b289c3.ae2c7eb8.js b/assets/js/29b289c3.ae2c7eb8.js deleted file mode 100644 index 33f05b15e8..0000000000 --- a/assets/js/29b289c3.ae2c7eb8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[747],{833:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>o});var r=i(4848),c=i(8453);const s={},l="Type Alias: StickerMetadata",d={id:"reference/api/model/media/type-aliases/StickerMetadata",title:"Type Alias: StickerMetadata",description:"StickerMetadata: object",source:"@site/docs/reference/api/model/media/type-aliases/StickerMetadata.md",sourceDirName:"reference/api/model/media/type-aliases",slug:"/reference/api/model/media/type-aliases/StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/type-aliases/StickerMetadata.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions"},next:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"}},t={},o=[{value:"Type declaration",id:"type-declaration",level:2},{value:"author",id:"author",level:3},{value:"Default",id:"default",level:4},{value:"circle?",id:"circle",level:3},{value:"cornerRadius?",id:"cornerradius",level:3},{value:"Default",id:"default-1",level:4},{value:"Minimum",id:"minimum",level:4},{value:"Maximum",id:"maximum",level:4},{value:"Multiple Of",id:"multiple-of",level:4},{value:"cropPosition?",id:"cropposition",level:3},{value:"Default",id:"default-2",level:4},{value:"discord?",id:"discord",level:3},{value:"keepScale?",id:"keepscale",level:3},{value:"pack",id:"pack",level:3},{value:"Default",id:"default-3",level:4},{value:"removebg?",id:"removebg",level:3},{value:"Default",id:"default-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-stickermetadata",children:"Type Alias: StickerMetadata"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"StickerMetadata"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"author",children:"author"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"author"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The author of the sticker"}),"\n",(0,r.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"``\n"})}),"\n",(0,r.jsx)(n.h3,{id:"circle",children:"circle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"circle"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Applies a circular mask to the sticker. Works on images only for now."}),"\n",(0,r.jsx)(n.h3,{id:"cornerradius",children:"cornerRadius?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cornerRadius"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The corner radius of the sticker when ",(0,r.jsx)(n.code,{children:"stickerMetadata.circle"})," is set to true."]}),"\n",(0,r.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"100"})}),"\n",(0,r.jsx)(n.h4,{id:"minimum",children:"Minimum"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"1"})}),"\n",(0,r.jsx)(n.h4,{id:"maximum",children:"Maximum"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"100"})}),"\n",(0,r.jsx)(n.h4,{id:"multiple-of",children:"Multiple Of"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"1"})}),"\n",(0,r.jsx)(n.h3,{id:"cropposition",children:"cropPosition?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cropPosition"}),": ",(0,r.jsx)(n.code,{children:'"top"'})," | ",(0,r.jsx)(n.code,{children:'"right top"'})," | ",(0,r.jsx)(n.code,{children:'"right"'})," | ",(0,r.jsx)(n.code,{children:'"right bottom"'})," | ",(0,r.jsx)(n.code,{children:'"bottom"'})," | ",(0,r.jsx)(n.code,{children:'"left bottom"'})," | ",(0,r.jsx)(n.code,{children:'"left"'})," | ",(0,r.jsx)(n.code,{children:'"left top"'})," | ",(0,r.jsx)(n.code,{children:'"north"'})," | ",(0,r.jsx)(n.code,{children:'"northeast"'})," | ",(0,r.jsx)(n.code,{children:'"east"'})," | ",(0,r.jsx)(n.code,{children:'"southeast"'})," | ",(0,r.jsx)(n.code,{children:'"south"'})," | ",(0,r.jsx)(n.code,{children:'"southwest"'})," | ",(0,r.jsx)(n.code,{children:'"west"'})," | ",(0,r.jsx)(n.code,{children:'"northwest"'})," | ",(0,r.jsx)(n.code,{children:'"center"'})," | ",(0,r.jsx)(n.code,{children:'"centre"'})," | ",(0,r.jsx)(n.code,{children:'"entropy"'})," | ",(0,r.jsx)(n.code,{children:'"attention"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Crop position"}),"\n",(0,r.jsxs)(n.p,{children:["Learn more: ",(0,r.jsx)(n.a,{href:"https://sharp.pixelplumbing.com/api-resize",children:"https://sharp.pixelplumbing.com/api-resize"})]}),"\n",(0,r.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"attention"})}),"\n",(0,r.jsx)(n.h3,{id:"discord",children:"discord?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"discord"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Your Discord ID to get onto the sticker leaderboard!"}),"\n",(0,r.jsx)(n.h3,{id:"keepscale",children:"keepScale?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"keepScale"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Setting this to ",(0,r.jsx)(n.code,{children:"true"})," will skip the resizing/square-cropping of the sticker. It will instead 'letterbox' the image with a transparent background."]}),"\n",(0,r.jsx)(n.h3,{id:"pack",children:"pack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"pack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The pack of the sticker"}),"\n",(0,r.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"``\n"})}),"\n",(0,r.jsx)(n.h3,{id:"removebg",children:"removebg?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"removebg"}),": ",(0,r.jsx)(n.code,{children:"boolean"})," | ",(0,r.jsx)(n.code,{children:'"HQ"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"ALPHA FEATURE - NO GUARANTEES IT WILL WORK AS EXPECTED:"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"REQUIRES AN INSIDERS LICENSE-KEY"})}),"\n",(0,r.jsx)(n.p,{children:"Attempt to remove the background of the sticker. Only valid for paid licenses."}),"\n",(0,r.jsx)(n.p,{children:"options:"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," - remove background after resizing"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"HQ"})," - remove background before resizing (i.e on original photo)"]}),"\n",(0,r.jsx)(n.h4,{id:"default-4",children:"Default"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"false"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>d});var r=i(6540);const c={},s=r.createContext(c);function l(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:l(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29fec1eb.309c211d.js b/assets/js/29fec1eb.309c211d.js new file mode 100644 index 0000000000..998a779998 --- /dev/null +++ b/assets/js/29fec1eb.309c211d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[986],{2307:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>c});var o=n(4848),s=n(8453);const a={},r="Send Video",i={id:"how-to/send-videos",title:"Send Video",description:"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.",source:"@site/docs/how-to/send-videos.md",sourceDirName:"how-to",slug:"/how-to/send-videos",permalink:"/docs/how-to/send-videos",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-videos.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Sending Messages",permalink:"/docs/how-to/send-messages"},next:{title:"SendFile",permalink:"/docs/how-to/sendfile"}},d={},c=[];function l(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"send-video",children:"Send Video"})}),"\n",(0,o.jsx)(t.p,{children:"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app."}),"\n",(0,o.jsx)(t.p,{children:"To use chrome set [[useChrome]] (finds the chrome installation automatically) to true or set the [[executablePath]] (set the chrome installation path manually)."}),"\n",(0,o.jsx)(t.p,{children:"[[useChrome]] takes a few seconds so to save time in consequtive processes set [[executablePath]] ([[useChrome]] will output the valid [[executablePath]] in the logs so keep an eye on them)"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-javascript",children:" client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')\n\n //send image as a reply to another message quotedMessageId\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)\n\n //wait for the Id to be returned\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)\n\n"})}),"\n",(0,o.jsx)(t.p,{children:"Example of config for sending videos:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-javascript",children:"create({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n}).then(client => start(client));\n"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>i});var o=n(6540);const s={},a=o.createContext(s);function r(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29fec1eb.450f571b.js b/assets/js/29fec1eb.450f571b.js deleted file mode 100644 index c00b6fa930..0000000000 --- a/assets/js/29fec1eb.450f571b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[986],{2307:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var o=n(4848),s=n(8453);const a={},r="Send Video",i={id:"how-to/send-videos",title:"Send Video",description:"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.",source:"@site/docs/how-to/send-videos.md",sourceDirName:"how-to",slug:"/how-to/send-videos",permalink:"/docs/how-to/send-videos",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-videos.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Sending Messages",permalink:"/docs/how-to/send-messages"},next:{title:"SendFile",permalink:"/docs/how-to/sendfile"}},c={},d=[];function l(e){const t={code:"code",h1:"h1",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"send-video",children:"Send Video"}),"\n",(0,o.jsx)(t.p,{children:"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app."}),"\n",(0,o.jsx)(t.p,{children:"To use chrome set [[useChrome]] (finds the chrome installation automatically) to true or set the [[executablePath]] (set the chrome installation path manually)."}),"\n",(0,o.jsx)(t.p,{children:"[[useChrome]] takes a few seconds so to save time in consequtive processes set [[executablePath]] ([[useChrome]] will output the valid [[executablePath]] in the logs so keep an eye on them)"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-javascript",children:" client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')\n\n //send image as a reply to another message quotedMessageId\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)\n\n //wait for the Id to be returned\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)\n\n"})}),"\n",(0,o.jsx)(t.p,{children:"Example of config for sending videos:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-javascript",children:"create({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n}).then(client => start(client));\n"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>i});var o=n(6540);const s={},a=o.createContext(s);function r(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2b136cef.9a5aa647.js b/assets/js/2b136cef.9a5aa647.js new file mode 100644 index 0000000000..059d24216d --- /dev/null +++ b/assets/js/2b136cef.9a5aa647.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[487],{5052:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=n(4848),o=n(8453);const i={},a="Capturing QR Code",c={id:"configuration/capture-qr",title:"Capturing QR Code",description:"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.",source:"@site/docs/configuration/capture-qr.md",sourceDirName:"configuration",slug:"/configuration/capture-qr",permalink:"/docs/configuration/capture-qr",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/capture-qr.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"The Client",permalink:"/docs/configuration/the-client"},next:{title:"Capturing the session data",permalink:"/docs/configuration/capture-sd"}},s={},d=[];function u(e){const t={a:"a",code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"capturing-qr-code",children:"Capturing QR Code"})}),"\n",(0,r.jsxs)(t.p,{children:["An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ",(0,r.jsx)(t.a,{href:"/TODO",children:(0,r.jsx)(t.code,{children:"ev"})}),". You can capture this qr code and save it to a file."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\nconst fs = require('fs');\n\nev.on('qr.**', async qrcode => {\n //qrcode is base64 encoded qr code image\n //now you can do whatever you want with it\n const imageBuffer = Buffer.from(\n qrcode.replace('data:image/png;base64,', ''),\n 'base64'\n );\n fs.writeFileSync('qr_code.png', imageBuffer);\n});\n"})})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2b136cef.bc56aed9.js b/assets/js/2b136cef.bc56aed9.js deleted file mode 100644 index 44f96d386f..0000000000 --- a/assets/js/2b136cef.bc56aed9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[487],{5052:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={},a="Capturing QR Code",c={id:"configuration/capture-qr",title:"Capturing QR Code",description:"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.",source:"@site/docs/configuration/capture-qr.md",sourceDirName:"configuration",slug:"/configuration/capture-qr",permalink:"/docs/configuration/capture-qr",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/capture-qr.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"The Client",permalink:"/docs/configuration/the-client"},next:{title:"Capturing the session data",permalink:"/docs/configuration/capture-sd"}},s={},u=[];function d(e){const t={a:"a",code:"code",h1:"h1",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"capturing-qr-code",children:"Capturing QR Code"}),"\n",(0,r.jsxs)(t.p,{children:["An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ",(0,r.jsx)(t.a,{href:"/TODO",children:(0,r.jsx)(t.code,{children:"ev"})}),". You can capture this qr code and save it to a file."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-javascript",children:"import { ev } from '@open-wa/wa-automate';\nconst fs = require('fs');\n\nev.on('qr.**', async qrcode => {\n //qrcode is base64 encoded qr code image\n //now you can do whatever you want with it\n const imageBuffer = Buffer.from(\n qrcode.replace('data:image/png;base64,', ''),\n 'base64'\n );\n fs.writeFileSync('qr_code.png', imageBuffer);\n});\n"})})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2ca4460e.84324a86.js b/assets/js/2ca4460e.84324a86.js new file mode 100644 index 0000000000..0ab2f30267 --- /dev/null +++ b/assets/js/2ca4460e.84324a86.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{5030:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var s=n(4848),o=n(8453);const a={},r="Type Alias: Content",i={id:"reference/api/model/aliases/type-aliases/Content",title:"Type Alias: Content",description:"Content: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/Content.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/Content.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId"},next:{title:"Type Alias: CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"type-alias-content",children:"Type Alias: Content"})}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Content"}),": ",(0,s.jsx)(t.code,{children:"Brand"}),"<",(0,s.jsx)(t.code,{children:"string"}),", ",(0,s.jsx)(t.code,{children:'"Content"'}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"This is a generic type alias for the content of a message"}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:'"hello!"'})})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>i});var s=n(6540);const o={},a=s.createContext(o);function r(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2ca4460e.da699626.js b/assets/js/2ca4460e.da699626.js deleted file mode 100644 index c0e8c389c8..0000000000 --- a/assets/js/2ca4460e.da699626.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{5030:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var s=n(4848),o=n(8453);const a={},r="Type Alias: Content",i={id:"reference/api/model/aliases/type-aliases/Content",title:"Type Alias: Content",description:"Content: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/Content.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/Content.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId"},next:{title:"Type Alias: CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-content",children:"Type Alias: Content"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Content"}),": ",(0,s.jsx)(t.code,{children:"Brand"}),"<",(0,s.jsx)(t.code,{children:"string"}),", ",(0,s.jsx)(t.code,{children:'"Content"'}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"This is a generic type alias for the content of a message"}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:'"hello!"'})})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>i});var s=n(6540);const o={},a=s.createContext(o);function r(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2d4ad45f.24a9ec9c.js b/assets/js/2d4ad45f.24a9ec9c.js new file mode 100644 index 0000000000..d13c5385df --- /dev/null +++ b/assets/js/2d4ad45f.24a9ec9c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5341],{1538:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=n(4848),a=n(8453);const c={},o="Type Alias: ContactId",r={id:"reference/api/model/aliases/type-aliases/ContactId",title:"Type Alias: ContactId",description:"ContactId: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/ContactId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ContactId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer"},next:{title:"Type Alias: Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content"}},i={},d=[];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"type-alias-contactid",children:"Type Alias: ContactId"})}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ContactId"}),": ",(0,s.jsx)(t.code,{children:"Brand"}),"<`${AccountNumber}@${ChatServer}`, ",(0,s.jsx)(t.code,{children:'"ContactId"'}),">"]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["A contact id ends with ",(0,s.jsx)(t.code,{children:"@c.us"})," and only contains the number of the contact. For example, if the country code of a contact is ",(0,s.jsx)(t.code,{children:"44"})," and their number is ",(0,s.jsx)(t.code,{children:"7123456789"})," then the contact id would be ",(0,s.jsx)(t.code,{children:"447123456789@c.us"})]}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:'"447123456789@c.us"'})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>r});var s=n(6540);const a={},c=s.createContext(a);function o(e){const t=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2d4ad45f.4f625f02.js b/assets/js/2d4ad45f.4f625f02.js deleted file mode 100644 index 7d19d2e2af..0000000000 --- a/assets/js/2d4ad45f.4f625f02.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5341],{1538:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=n(4848),a=n(8453);const c={},o="Type Alias: ContactId",r={id:"reference/api/model/aliases/type-aliases/ContactId",title:"Type Alias: ContactId",description:"ContactId: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/ContactId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ContactId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer"},next:{title:"Type Alias: Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content"}},i={},d=[];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-contactid",children:"Type Alias: ContactId"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ContactId"}),": ",(0,s.jsx)(t.code,{children:"Brand"}),"<`${AccountNumber}@${ChatServer}`, ",(0,s.jsx)(t.code,{children:'"ContactId"'}),">"]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["A contact id ends with ",(0,s.jsx)(t.code,{children:"@c.us"})," and only contains the number of the contact. For example, if the country code of a contact is ",(0,s.jsx)(t.code,{children:"44"})," and their number is ",(0,s.jsx)(t.code,{children:"7123456789"})," then the contact id would be ",(0,s.jsx)(t.code,{children:"447123456789@c.us"})]}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:'"447123456789@c.us"'})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>r});var s=n(6540);const a={},c=s.createContext(a);function o(e){const t=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2eaaacd8.41b83e0e.js b/assets/js/2eaaacd8.41b83e0e.js deleted file mode 100644 index 9885cfddda..0000000000 --- a/assets/js/2eaaacd8.41b83e0e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[858],{6546:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=t(4848),s=t(8453);const o={},c="Variable: screenshot",i={id:"reference/controllers/initializer/variables/screenshot",title:"Variable: screenshot",description:"screenshot: any",source:"@site/docs/reference/controllers/initializer/variables/screenshot.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/screenshot.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg"},next:{title:"controllers/patch\\_manager",permalink:"/docs/reference/controllers/patch_manager/"}},a={},l=[];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"variable-screenshot",children:"Variable: screenshot"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"screenshot"}),": ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>i});var n=t(6540);const s={},o=n.createContext(s);function c(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2eaaacd8.60a283f8.js b/assets/js/2eaaacd8.60a283f8.js new file mode 100644 index 0000000000..692e2a08b9 --- /dev/null +++ b/assets/js/2eaaacd8.60a283f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[858],{6546:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=n(4848),s=n(8453);const o={},c="Variable: screenshot",i={id:"reference/controllers/initializer/variables/screenshot",title:"Variable: screenshot",description:"screenshot: any",source:"@site/docs/reference/controllers/initializer/variables/screenshot.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/screenshot.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg"},next:{title:"controllers/patch\\_manager",permalink:"/docs/reference/controllers/patch_manager/"}},a={},l=[];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"variable-screenshot",children:"Variable: screenshot"})}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"screenshot"}),": ",(0,t.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>c,x:()=>i});var t=n(6540);const s={},o=t.createContext(s);function c(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2f74e3d4.674891b1.js b/assets/js/2f74e3d4.674891b1.js deleted file mode 100644 index 30d204dff6..0000000000 --- a/assets/js/2f74e3d4.674891b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3534],{2971:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var s=n(4848),t=n(8453);const c={},d="Interface: Order",i={id:"reference/api/model/product/interfaces/Order",title:"Interface: Order",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/Order.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/Order",permalink:"/docs/reference/api/model/product/interfaces/Order",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/Order.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct"},next:{title:"Interface: Product",permalink:"/docs/reference/api/model/product/interfaces/Product"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"createdAt",id:"createdat",level:3},{value:"currency",id:"currency",level:3},{value:"id",id:"id",level:3},{value:"message?",id:"message",level:3},{value:"products",id:"products",level:3},{value:"sellerJid",id:"sellerjid",level:3},{value:"subtotal",id:"subtotal",level:3},{value:"total",id:"total",level:3}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"interface-order",children:"Interface: Order"}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"createdat",children:"createdAt"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"createdAt"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"epoch ts divided by 1000"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"currency",children:"currency"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"currency"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The ",(0,s.jsx)(r.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,s.jsx)(r.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,s.jsx)(r.code,{children:"SEK"})]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"id"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Order ID"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"message",children:"message?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(r.code,{children:"Message"})})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The message object associated with the order. Only populated in ",(0,s.jsx)(r.code,{children:"onOrder"})," callback."]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"products",children:"products"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"products"}),": ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:(0,s.jsx)(r.code,{children:"CartItem"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"An array of items in the cart"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"sellerjid",children:"sellerJid"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"sellerJid"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"subtotal",children:"subtotal"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"subtotal"}),": `${number}`"]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"total",children:"total"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"total"}),": `${number}`"]}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>i});var s=n(6540);const t={},c=s.createContext(t);function d(e){const r=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2f74e3d4.fd5601b8.js b/assets/js/2f74e3d4.fd5601b8.js new file mode 100644 index 0000000000..ba3bffec8a --- /dev/null +++ b/assets/js/2f74e3d4.fd5601b8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3534],{2971:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var s=n(4848),c=n(8453);const t={},d="Interface: Order",i={id:"reference/api/model/product/interfaces/Order",title:"Interface: Order",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/Order.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/Order",permalink:"/docs/reference/api/model/product/interfaces/Order",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/Order.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct"},next:{title:"Interface: Product",permalink:"/docs/reference/api/model/product/interfaces/Product"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"createdAt",id:"createdat",level:3},{value:"currency",id:"currency",level:3},{value:"id",id:"id",level:3},{value:"message?",id:"message",level:3},{value:"products",id:"products",level:3},{value:"sellerJid",id:"sellerjid",level:3},{value:"subtotal",id:"subtotal",level:3},{value:"total",id:"total",level:3}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"interface-order",children:"Interface: Order"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"createdat",children:"createdAt"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"createdAt"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"epoch ts divided by 1000"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"currency",children:"currency"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"currency"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The ",(0,s.jsx)(r.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,s.jsx)(r.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,s.jsx)(r.code,{children:"SEK"})]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"id"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Order ID"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"message",children:"message?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(r.code,{children:"Message"})})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The message object associated with the order. Only populated in ",(0,s.jsx)(r.code,{children:"onOrder"})," callback."]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"products",children:"products"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"products"}),": ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:(0,s.jsx)(r.code,{children:"CartItem"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"An array of items in the cart"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"sellerjid",children:"sellerJid"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"sellerJid"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"subtotal",children:"subtotal"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"subtotal"}),": `${number}`"]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"total",children:"total"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"total"}),": `${number}`"]}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>i});var s=n(6540);const c={},t=s.createContext(c);function d(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2fc4fc5f.32a3610a.js b/assets/js/2fc4fc5f.32a3610a.js deleted file mode 100644 index 0b3d07ca45..0000000000 --- a/assets/js/2fc4fc5f.32a3610a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[730],{1619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var r=n(4848),o=n(8453);const c={},s="Interface: Section",i={id:"reference/api/model/button/interfaces/Section",title:"Interface: Section",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Section.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Section",permalink:"/docs/reference/api/model/button/interfaces/Section",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Section.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Row",permalink:"/docs/reference/api/model/button/interfaces/Row"},next:{title:"api/model/call",permalink:"/docs/reference/api/model/call/"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"rows",id:"rows",level:3},{value:"title",id:"title",level:3}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-section",children:"Interface: Section"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"rows",children:"rows"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rows"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:(0,r.jsx)(t.code,{children:"Row"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>i});var r=n(6540);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2fc4fc5f.6ba2bf88.js b/assets/js/2fc4fc5f.6ba2bf88.js new file mode 100644 index 0000000000..27fa15ae83 --- /dev/null +++ b/assets/js/2fc4fc5f.6ba2bf88.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[730],{1619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var r=n(4848),o=n(8453);const c={},s="Interface: Section",i={id:"reference/api/model/button/interfaces/Section",title:"Interface: Section",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Section.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Section",permalink:"/docs/reference/api/model/button/interfaces/Section",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Section.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Row",permalink:"/docs/reference/api/model/button/interfaces/Row"},next:{title:"api/model/call",permalink:"/docs/reference/api/model/call/"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"rows",id:"rows",level:3},{value:"title",id:"title",level:3}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-section",children:"Interface: Section"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"rows",children:"rows"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rows"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:(0,r.jsx)(t.code,{children:"Row"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>i});var r=n(6540);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3242.7a6918db.js b/assets/js/3242.7a6918db.js deleted file mode 100644 index 66d1ab01ee..0000000000 --- a/assets/js/3242.7a6918db.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3242],{6535:(e,t,a)=>{a.d(t,{A:()=>b});var s=a(6540),n=a(4164),r=a(9201),l=a(4581),i=a(8774),o=a(1312),c=a(6347),d=a(9169);function m(e){const{pathname:t}=(0,c.zy)();return(0,s.useMemo)((()=>e.filter((e=>function(e,t){return!(e.unlisted&&!(0,d.ys)(e.permalink,t))}(e,t)))),[e,t])}const u={sidebar:"sidebar_re4s",sidebarItemTitle:"sidebarItemTitle_pO2u",sidebarItemList:"sidebarItemList_Yudw",sidebarItem:"sidebarItem__DBe",sidebarItemLink:"sidebarItemLink_mo7H",sidebarItemLinkActive:"sidebarItemLinkActive_I1ZP"};var h=a(4848);function g(e){let{sidebar:t}=e;const a=m(t.items);return(0,h.jsx)("aside",{className:"col col--3",children:(0,h.jsxs)("nav",{className:(0,n.A)(u.sidebar,"thin-scrollbar"),"aria-label":(0,o.T)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"}),children:[(0,h.jsx)("div",{className:(0,n.A)(u.sidebarItemTitle,"margin-bottom--md"),children:t.title}),(0,h.jsx)("ul",{className:(0,n.A)(u.sidebarItemList,"clean-list"),children:a.map((e=>(0,h.jsx)("li",{className:u.sidebarItem,children:(0,h.jsx)(i.A,{isNavLink:!0,to:e.permalink,className:u.sidebarItemLink,activeClassName:u.sidebarItemLinkActive,children:e.title})},e.permalink)))})]})})}var x=a(5600);function j(e){let{sidebar:t}=e;const a=m(t.items);return(0,h.jsx)("ul",{className:"menu__list",children:a.map((e=>(0,h.jsx)("li",{className:"menu__list-item",children:(0,h.jsx)(i.A,{isNavLink:!0,to:e.permalink,className:"menu__link",activeClassName:"menu__link--active",children:e.title})},e.permalink)))})}function p(e){return(0,h.jsx)(x.GX,{component:j,props:e})}function f(e){let{sidebar:t}=e;const a=(0,l.l)();return t?.items.length?"mobile"===a?(0,h.jsx)(p,{sidebar:t}):(0,h.jsx)(g,{sidebar:t}):null}function b(e){const{sidebar:t,toc:a,children:s,...l}=e,i=t&&t.items.length>0;return(0,h.jsx)(r.A,{...l,children:(0,h.jsx)("div",{className:"container margin-vert--lg",children:(0,h.jsxs)("div",{className:"row",children:[(0,h.jsx)(f,{sidebar:t}),(0,h.jsx)("main",{className:(0,n.A)("col",{"col--7":i,"col--9 col--offset-1":!i}),children:s}),a&&(0,h.jsx)("div",{className:"col col--2",children:a})]})})})}},4651:(e,t,a)=>{a.d(t,{A:()=>R});a(6540);var s=a(4164),n=a(7131),r=a(4848);function l(e){let{children:t,className:a}=e;return(0,r.jsx)("article",{className:a,children:t})}var i=a(8774);const o={title:"title_f1Hy"};function c(e){let{className:t}=e;const{metadata:a,isBlogPostPage:l}=(0,n.e)(),{permalink:c,title:d}=a,m=l?"h1":"h2";return(0,r.jsx)(m,{className:(0,s.A)(o.title,t),children:l?d:(0,r.jsx)(i.A,{to:c,children:d})})}var d=a(1312),m=a(5846),u=a(6266);const h={container:"container_mt6G"};function g(e){let{readingTime:t}=e;const a=function(){const{selectMessage:e}=(0,m.W)();return t=>{const a=Math.ceil(t);return e(a,(0,d.T)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:a}))}}();return(0,r.jsx)(r.Fragment,{children:a(t)})}function x(e){let{date:t,formattedDate:a}=e;return(0,r.jsx)("time",{dateTime:t,children:a})}function j(){return(0,r.jsx)(r.Fragment,{children:" \xb7 "})}function p(e){let{className:t}=e;const{metadata:a}=(0,n.e)(),{date:l,readingTime:i}=a,o=(0,u.i)({day:"numeric",month:"long",year:"numeric",timeZone:"UTC"});return(0,r.jsxs)("div",{className:(0,s.A)(h.container,"margin-vert--md",t),children:[(0,r.jsx)(x,{date:l,formattedDate:(c=l,o.format(new Date(c)))}),void 0!==i&&(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(j,{}),(0,r.jsx)(g,{readingTime:i})]})]});var c}function f(e){return e.href?(0,r.jsx)(i.A,{...e}):(0,r.jsx)(r.Fragment,{children:e.children})}function b(e){let{author:t,className:a}=e;const{name:n,title:l,url:i,imageURL:o,email:c}=t,d=i||c&&`mailto:${c}`||void 0;return(0,r.jsxs)("div",{className:(0,s.A)("avatar margin-bottom--sm",a),children:[o&&(0,r.jsx)(f,{href:d,className:"avatar__photo-link",children:(0,r.jsx)("img",{className:"avatar__photo",src:o,alt:n})}),n&&(0,r.jsxs)("div",{className:"avatar__intro",children:[(0,r.jsx)("div",{className:"avatar__name",children:(0,r.jsx)(f,{href:d,children:(0,r.jsx)("span",{children:n})})}),l&&(0,r.jsx)("small",{className:"avatar__subtitle",children:l})]})]})}const v={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function A(e){let{className:t}=e;const{metadata:{authors:a},assets:l}=(0,n.e)();if(0===a.length)return null;const i=a.every((e=>{let{name:t}=e;return!t}));return(0,r.jsx)("div",{className:(0,s.A)("margin-top--md margin-bottom--sm",i?v.imageOnlyAuthorRow:"row",t),children:a.map(((e,t)=>(0,r.jsx)("div",{className:(0,s.A)(!i&&"col col--6",i?v.imageOnlyAuthorCol:v.authorCol),children:(0,r.jsx)(b,{author:{...e,imageURL:l.authorsImageUrls[t]??e.imageURL}})},t)))})}function N(){return(0,r.jsxs)("header",{children:[(0,r.jsx)(c,{}),(0,r.jsx)(p,{}),(0,r.jsx)(A,{})]})}var _=a(440),k=a(8509);function P(e){let{children:t,className:a}=e;const{isBlogPostPage:l}=(0,n.e)();return(0,r.jsx)("div",{id:l?_.blogPostContainerID:void 0,className:(0,s.A)("markdown",a),children:(0,r.jsx)(k.A,{children:t})})}var w=a(7559),T=a(4336),I=a(2053);function L(){return(0,r.jsx)("b",{children:(0,r.jsx)(d.A,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts",children:"Read More"})})}function y(e){const{blogPostTitle:t,...a}=e;return(0,r.jsx)(i.A,{"aria-label":(0,d.T)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t}),...a,children:(0,r.jsx)(L,{})})}function C(){const{metadata:e,isBlogPostPage:t}=(0,n.e)(),{tags:a,title:l,editUrl:i,hasTruncateMarker:o,lastUpdatedBy:c,lastUpdatedAt:d}=e,m=!t&&o,u=a.length>0;if(!(u||m||i))return null;if(t){const e=!!(i||d||c);return(0,r.jsxs)("footer",{className:"docusaurus-mt-lg",children:[u&&(0,r.jsx)("div",{className:(0,s.A)("row","margin-top--sm",w.G.blog.blogFooterEditMetaRow),children:(0,r.jsx)("div",{className:"col",children:(0,r.jsx)(I.A,{tags:a})})}),e&&(0,r.jsx)(T.A,{className:(0,s.A)("margin-top--sm",w.G.blog.blogFooterEditMetaRow),editUrl:i,lastUpdatedAt:d,lastUpdatedBy:c})]})}return(0,r.jsxs)("footer",{className:"row docusaurus-mt-lg",children:[u&&(0,r.jsx)("div",{className:(0,s.A)("col",{"col--9":m}),children:(0,r.jsx)(I.A,{tags:a})}),m&&(0,r.jsx)("div",{className:(0,s.A)("col text--right",{"col--3":u}),children:(0,r.jsx)(y,{blogPostTitle:l,to:e.permalink})})]})}function R(e){let{children:t,className:a}=e;const i=function(){const{isBlogPostPage:e}=(0,n.e)();return e?void 0:"margin-bottom--xl"}();return(0,r.jsxs)(l,{className:(0,s.A)(i,a),children:[(0,r.jsx)(N,{}),(0,r.jsx)(P,{children:t}),(0,r.jsx)(C,{})]})}},9022:(e,t,a)=>{a.d(t,{A:()=>l});a(6540);var s=a(4164),n=a(8774),r=a(4848);function l(e){const{permalink:t,title:a,subLabel:l,isNext:i}=e;return(0,r.jsxs)(n.A,{className:(0,s.A)("pagination-nav__link",i?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[l&&(0,r.jsx)("div",{className:"pagination-nav__sublabel",children:l}),(0,r.jsx)("div",{className:"pagination-nav__label",children:a})]})}},6133:(e,t,a)=>{a.d(t,{A:()=>i});a(6540);var s=a(4164),n=a(8774);const r={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var l=a(4848);function i(e){let{permalink:t,label:a,count:i,description:o}=e;return(0,l.jsxs)(n.A,{href:t,title:o,className:(0,s.A)(r.tag,i?r.tagWithCount:r.tagRegular),children:[a,i&&(0,l.jsx)("span",{children:i})]})}},2053:(e,t,a)=>{a.d(t,{A:()=>o});a(6540);var s=a(4164),n=a(1312),r=a(6133);const l={tags:"tags_jXut",tag:"tag_QGVx"};var i=a(4848);function o(e){let{tags:t}=e;return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("b",{children:(0,i.jsx)(n.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,i.jsx)("ul",{className:(0,s.A)(l.tags,"padding--none","margin-left--sm"),children:t.map((e=>(0,i.jsx)("li",{className:l.tag,children:(0,i.jsx)(r.A,{...e})},e.permalink)))})]})}},7131:(e,t,a)=>{a.d(t,{e:()=>o,i:()=>i});var s=a(6540),n=a(9532),r=a(4848);const l=s.createContext(null);function i(e){let{children:t,content:a,isBlogPostPage:n=!1}=e;const i=function(e){let{content:t,isBlogPostPage:a}=e;return(0,s.useMemo)((()=>({metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,toc:t.toc,isBlogPostPage:a})),[t,a])}({content:a,isBlogPostPage:n});return(0,r.jsx)(l.Provider,{value:i,children:t})}function o(){const e=(0,s.useContext)(l);if(null===e)throw new n.dV("BlogPostProvider");return e}},5846:(e,t,a)=>{a.d(t,{W:()=>c});var s=a(6540),n=a(4586);const r=["zero","one","two","few","many","other"];function l(e){return r.filter((t=>e.includes(t)))}const i={locale:"en",pluralForms:l(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,n.A)();return(0,s.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:l(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),i}}),[e])}function c(){const e=o();return{selectMessage:(t,a)=>function(e,t,a){const s=e.split("|");if(1===s.length)return s[0];s.length>a.pluralForms.length&&console.error(`For locale=${a.locale}, a maximum of ${a.pluralForms.length} plural forms are expected (${a.pluralForms.join(",")}), but the message contains ${s.length}: ${e}`);const n=a.select(t),r=a.pluralForms.indexOf(n);return s[Math.min(r,s.length-1)]}(a,t,e)}}}}]); \ No newline at end of file diff --git a/assets/js/3347.84a47663.js b/assets/js/3347.84a47663.js new file mode 100644 index 0000000000..71aaafc7aa --- /dev/null +++ b/assets/js/3347.84a47663.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3347],{4096:(e,t,a)=>{a.d(t,{in:()=>c,OU:()=>_,Ki:()=>M,kJ:()=>f,x:()=>i,e7:()=>u,J_:()=>x,Gx:()=>A});var n=a(6540),s=a(9532),r=a(6803),l=a(4848);function i(){const e=(0,r.A)(),t=e?.data?.blogMetadata;if(!t)throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");return t}const o=n.createContext(null);function c(e){let{children:t,content:a,isBlogPostPage:s=!1}=e;const r=function(e){let{content:t,isBlogPostPage:a}=e;return(0,n.useMemo)((()=>({metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,toc:t.toc,isBlogPostPage:a})),[t,a])}({content:a,isBlogPostPage:s});return(0,l.jsx)(o.Provider,{value:r,children:t})}function u(){const e=(0,n.useContext)(o);if(null===e)throw new s.dV("BlogPostProvider");return e}var m=a(6025),h=a(4586);const d=e=>new Date(e).toISOString();function g(e){const t=e.map(v);return{author:1===t.length?t[0]:t}}function p(e,t,a){return e?{image:j({imageUrl:t(e,{absolute:!0}),caption:`title image for the blog post: ${a}`})}:{}}function f(e){const{siteConfig:t}=(0,h.A)(),{withBaseUrl:a}=(0,m.hH)(),{metadata:{blogDescription:n,blogTitle:s,permalink:r}}=e,l=`${t.url}${r}`;return{"@context":"https://schema.org","@type":"Blog","@id":l,mainEntityOfPage:l,headline:s,description:n,blogPost:e.items.map((e=>function(e,t,a){const{assets:n,frontMatter:s,metadata:r}=e,{date:l,title:i,description:o,lastUpdatedAt:c}=r,u=n.image??s.image,m=s.keywords??[],h=`${t.url}${r.permalink}`,f=c?d(c):void 0;return{"@type":"BlogPosting","@id":h,mainEntityOfPage:h,url:h,headline:i,name:i,description:o,datePublished:l,...f?{dateModified:f}:{},...g(r.authors),...p(u,a,i),...m?{keywords:m}:{}}}(e.content,t,a)))}}function x(){const e=i(),{assets:t,metadata:a}=u(),{siteConfig:n}=(0,h.A)(),{withBaseUrl:s}=(0,m.hH)(),{date:r,title:l,description:o,frontMatter:c,lastUpdatedAt:f}=a,x=t.image??c.image,v=c.keywords??[],j=f?d(f):void 0,b=`${n.url}${a.permalink}`;return{"@context":"https://schema.org","@type":"BlogPosting","@id":b,mainEntityOfPage:b,url:b,headline:l,name:l,description:o,datePublished:r,...j?{dateModified:j}:{},...g(a.authors),...p(x,s,l),...v?{keywords:v}:{},isPartOf:{"@type":"Blog","@id":`${n.url}${e.blogBasePath}`,name:e.blogTitle}}}function v(e){return{"@type":"Person",...e.name?{name:e.name}:{},...e.title?{description:e.title}:{},...e.url?{url:e.url}:{},...e.email?{email:e.email}:{},...e.imageURL?{image:e.imageURL}:{}}}function j(e){let{imageUrl:t,caption:a}=e;return{"@type":"ImageObject","@id":t,url:t,contentUrl:t,caption:a}}var b=a(6347),w=a(8774),N=a(1682),k=a(9169);function A(e){const{pathname:t}=(0,b.zy)();return(0,n.useMemo)((()=>e.filter((e=>function(e,t){return!(e.unlisted&&!(0,k.ys)(e.permalink,t))}(e,t)))),[e,t])}function M(e){const t=(0,N.$z)(e,(e=>`${new Date(e.date).getFullYear()}`)),a=Object.entries(t);return a.reverse(),a}function _(e){let{items:t,ulClassName:a,liClassName:n,linkClassName:s,linkActiveClassName:r}=e;return(0,l.jsx)("ul",{className:a,children:t.map((e=>(0,l.jsx)("li",{className:n,children:(0,l.jsx)(w.A,{isNavLink:!0,to:e.permalink,className:s,activeClassName:r,children:e.title})},e.permalink)))})}},6913:(e,t,a)=>{a.d(t,{A:()=>j});a(6540);var n=a(4164),s=a(8774),r=a(4848);const l="githubSvg_Uu4N";const i="xSvg_y3PF";const o=function(e){return(0,r.jsxs)("svg",{xmlns:"http://www.w3.org/2000/svg",width:"1em",height:"1em",viewBox:"0 0 24 24",fill:"none",stroke:"currentColor",strokeWidth:"2",strokeLinecap:"round",strokeLinejoin:"round",...e,children:[(0,r.jsx)("path",{stroke:"none",d:"M0 0h24v24H0z",fill:"none"}),(0,r.jsx)("path",{d:"M3 12a9 9 0 1 0 18 0a9 9 0 0 0 -18 0"}),(0,r.jsx)("path",{d:"M3.6 9h16.8"}),(0,r.jsx)("path",{d:"M3.6 15h16.8"}),(0,r.jsx)("path",{d:"M11.5 3a17 17 0 0 0 0 18"}),(0,r.jsx)("path",{d:"M12.5 3a17 17 0 0 1 0 18"})]})},c={authorSocials:"authorSocials_rSDt",authorSocialLink:"authorSocialLink_owbf",authorSocialIcon:"authorSocialIcon_XYv3"},u={twitter:{Icon:function(e){return(0,r.jsx)("svg",{viewBox:"0 0 256 209",width:"1em",height:"1em",xmlns:"http://www.w3.org/2000/svg",preserveAspectRatio:"xMidYMid",...e,children:(0,r.jsx)("path",{d:"M256 25.45c-9.42 4.177-19.542 7-30.166 8.27 10.845-6.5 19.172-16.793 23.093-29.057a105.183 105.183 0 0 1-33.351 12.745C205.995 7.201 192.346.822 177.239.822c-29.006 0-52.523 23.516-52.523 52.52 0 4.117.465 8.125 1.36 11.97-43.65-2.191-82.35-23.1-108.255-54.876-4.52 7.757-7.11 16.78-7.11 26.404 0 18.222 9.273 34.297 23.365 43.716a52.312 52.312 0 0 1-23.79-6.57c-.003.22-.003.44-.003.661 0 25.447 18.104 46.675 42.13 51.5a52.592 52.592 0 0 1-23.718.9c6.683 20.866 26.08 36.05 49.062 36.475-17.975 14.086-40.622 22.483-65.228 22.483-4.24 0-8.42-.249-12.529-.734 23.243 14.902 50.85 23.597 80.51 23.597 96.607 0 149.434-80.031 149.434-149.435 0-2.278-.05-4.543-.152-6.795A106.748 106.748 0 0 0 256 25.45",fill:"#55acee"})})},label:"Twitter"},github:{Icon:function(e){return(0,r.jsx)("svg",{viewBox:"0 0 256 250",width:"1em",height:"1em",...e,className:(0,n.A)(e.className,l),xmlns:"http://www.w3.org/2000/svg",style:{"--dark":"#000","--light":"#fff"},preserveAspectRatio:"xMidYMid",children:(0,r.jsx)("path",{d:"M128.001 0C57.317 0 0 57.307 0 128.001c0 56.554 36.676 104.535 87.535 121.46 6.397 1.185 8.746-2.777 8.746-6.158 0-3.052-.12-13.135-.174-23.83-35.61 7.742-43.124-15.103-43.124-15.103-5.823-14.795-14.213-18.73-14.213-18.73-11.613-7.944.876-7.78.876-7.78 12.853.902 19.621 13.19 19.621 13.19 11.417 19.568 29.945 13.911 37.249 10.64 1.149-8.272 4.466-13.92 8.127-17.116-28.431-3.236-58.318-14.212-58.318-63.258 0-13.975 5-25.394 13.188-34.358-1.329-3.224-5.71-16.242 1.24-33.874 0 0 10.749-3.44 35.21 13.121 10.21-2.836 21.16-4.258 32.038-4.307 10.878.049 21.837 1.47 32.066 4.307 24.431-16.56 35.165-13.12 35.165-13.12 6.967 17.63 2.584 30.65 1.255 33.873 8.207 8.964 13.173 20.383 13.173 34.358 0 49.163-29.944 59.988-58.447 63.157 4.591 3.972 8.682 11.762 8.682 23.704 0 17.126-.148 30.91-.148 35.126 0 3.407 2.304 7.398 8.792 6.14C219.37 232.5 256 184.537 256 128.002 256 57.307 198.691 0 128.001 0Zm-80.06 182.34c-.282.636-1.283.827-2.194.39-.929-.417-1.45-1.284-1.15-1.922.276-.655 1.279-.838 2.205-.399.93.418 1.46 1.293 1.139 1.931Zm6.296 5.618c-.61.566-1.804.303-2.614-.591-.837-.892-.994-2.086-.375-2.66.63-.566 1.787-.301 2.626.591.838.903 1 2.088.363 2.66Zm4.32 7.188c-.785.545-2.067.034-2.86-1.104-.784-1.138-.784-2.503.017-3.05.795-.547 2.058-.055 2.861 1.075.782 1.157.782 2.522-.019 3.08Zm7.304 8.325c-.701.774-2.196.566-3.29-.49-1.119-1.032-1.43-2.496-.726-3.27.71-.776 2.213-.558 3.315.49 1.11 1.03 1.45 2.505.701 3.27Zm9.442 2.81c-.31 1.003-1.75 1.459-3.199 1.033-1.448-.439-2.395-1.613-2.103-2.626.301-1.01 1.747-1.484 3.207-1.028 1.446.436 2.396 1.602 2.095 2.622Zm10.744 1.193c.036 1.055-1.193 1.93-2.715 1.95-1.53.034-2.769-.82-2.786-1.86 0-1.065 1.202-1.932 2.733-1.958 1.522-.03 2.768.818 2.768 1.868Zm10.555-.405c.182 1.03-.875 2.088-2.387 2.37-1.485.271-2.861-.365-3.05-1.386-.184-1.056.893-2.114 2.376-2.387 1.514-.263 2.868.356 3.061 1.403Z"})})},label:"GitHub"},stackoverflow:{Icon:function(e){return(0,r.jsxs)("svg",{xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 169.61 200",width:"1em",height:"1em",...e,children:[(0,r.jsx)("path",{d:"M140.44 178.38v-48.65h21.61V200H0v-70.27h21.61v48.65z",fill:"#bcbbbb"}),(0,r.jsx)("path",{d:"M124.24 140.54l4.32-16.22-86.97-17.83-3.78 17.83zM49.7 82.16L130.72 120l7.56-16.22-81.02-37.83zm22.68-40l68.06 57.3 11.35-13.51-68.6-57.3-11.35 13.51zM116.14 0l-14.59 10.81 53.48 71.89 14.58-10.81zM37.81 162.16h86.43v-16.21H37.81z",fill:"#f48024"})]})},label:"Stack Overflow"},linkedin:{Icon:function(e){return(0,r.jsx)("svg",{width:"1em",height:"1em",xmlns:"http://www.w3.org/2000/svg",preserveAspectRatio:"xMidYMid",viewBox:"0 0 256 256",...e,children:(0,r.jsx)("path",{d:"M218.123 218.127h-37.931v-59.403c0-14.165-.253-32.4-19.728-32.4-19.756 0-22.779 15.434-22.779 31.369v60.43h-37.93V95.967h36.413v16.694h.51a39.907 39.907 0 0 1 35.928-19.733c38.445 0 45.533 25.288 45.533 58.186l-.016 67.013ZM56.955 79.27c-12.157.002-22.014-9.852-22.016-22.009-.002-12.157 9.851-22.014 22.008-22.016 12.157-.003 22.014 9.851 22.016 22.008A22.013 22.013 0 0 1 56.955 79.27m18.966 138.858H37.95V95.967h37.97v122.16ZM237.033.018H18.89C8.58-.098.125 8.161-.001 18.471v219.053c.122 10.315 8.576 18.582 18.89 18.474h218.144c10.336.128 18.823-8.139 18.966-18.474V18.454c-.147-10.33-8.635-18.588-18.966-18.453",fill:"#0A66C2"})})},label:"LinkedIn"},x:{Icon:function(e){return(0,r.jsx)("svg",{xmlns:"http://www.w3.org/2000/svg",width:"1em",height:"1em",fill:"none",viewBox:"0 0 1200 1227",...e,className:(0,n.A)(e.className,i),style:{"--dark":"#000","--light":"#fff"},children:(0,r.jsx)("path",{d:"M714.163 519.284 1160.89 0h-105.86L667.137 450.887 357.328 0H0l468.492 681.821L0 1226.37h105.866l409.625-476.152 327.181 476.152H1200L714.137 519.284h.026ZM569.165 687.828l-47.468-67.894-377.686-540.24h162.604l304.797 435.991 47.468 67.894 396.2 566.721H892.476L569.165 687.854v-.026Z"})})},label:"X"}};function m(e){let{platform:t,link:a}=e;const{Icon:l,label:i}=u[m=t]??{Icon:o,label:m};var m;return(0,r.jsx)(s.A,{className:c.authorSocialLink,href:a,title:i,children:(0,r.jsx)(l,{className:(0,n.A)(c.authorSocialLink)})})}function h(e){let{author:t}=e;const a=Object.entries(t.socials??{});return(0,r.jsx)("div",{className:c.authorSocials,children:a.map((e=>{let[t,a]=e;return(0,r.jsx)(m,{platform:t,link:a},t)}))})}var d=a(1107);const g={authorImage:"authorImage_XqGP","author-as-h1":"author-as-h1_n9oJ","author-as-h2":"author-as-h2_gXvM",authorDetails:"authorDetails_lV9A",authorName:"authorName_yefp",authorTitle:"authorTitle_nd0D",authorBlogPostCount:"authorBlogPostCount_iiJ5"};function p(e){return e.href?(0,r.jsx)(s.A,{...e}):(0,r.jsx)(r.Fragment,{children:e.children})}function f(e){let{title:t}=e;return(0,r.jsx)("small",{className:g.authorTitle,title:t,children:t})}function x(e){let{name:t,as:a}=e;return a?(0,r.jsx)(d.A,{as:a,className:g.authorName,children:t}):(0,r.jsx)("span",{className:g.authorName,children:t})}function v(e){let{count:t}=e;return(0,r.jsx)("span",{className:(0,n.A)(g.authorBlogPostCount),children:t})}function j(e){let{as:t,author:a,className:s,count:l}=e;const{name:i,title:o,url:c,imageURL:u,email:m,page:d}=a,j=d?.permalink||c||m&&`mailto:${m}`||void 0;return(0,r.jsxs)("div",{className:(0,n.A)("avatar margin-bottom--sm",s,g[`author-as-${t}`]),children:[u&&(0,r.jsx)(p,{href:j,className:"avatar__photo-link",children:(0,r.jsx)("img",{className:(0,n.A)("avatar__photo",g.authorImage),src:u,alt:i})}),(i||o)&&(0,r.jsxs)("div",{className:(0,n.A)("avatar__intro",g.authorDetails),children:[(0,r.jsxs)("div",{className:"avatar__name",children:[i&&(0,r.jsx)(p,{href:j,children:(0,r.jsx)(x,{name:i,as:t})}),l&&(0,r.jsx)(v,{count:l})]}),!!o&&(0,r.jsx)(f,{title:o}),(0,r.jsx)(h,{author:a})]})]})}},8027:(e,t,a)=>{a.d(t,{A:()=>L});var n=a(6540),s=a(4164),r=a(3277),l=a(4581),i=a(1312),o=a(4096),c=a(6342),u=a(1107),m=a(4848);function h(e){let{year:t,yearGroupHeadingClassName:a,children:n}=e;return(0,m.jsxs)("div",{role:"group",children:[(0,m.jsx)(u.A,{as:"h3",className:a,children:t}),n]})}function d(e){let{items:t,yearGroupHeadingClassName:a,ListComponent:n}=e;if((0,c.p)().blog.sidebar.groupByYear){const e=(0,o.Ki)(t);return(0,m.jsx)(m.Fragment,{children:e.map((e=>{let[t,s]=e;return(0,m.jsx)(h,{year:t,yearGroupHeadingClassName:a,children:(0,m.jsx)(n,{items:s})},t)}))})}return(0,m.jsx)(n,{items:t})}const g=(0,n.memo)(d),p="sidebar_re4s",f="sidebarItemTitle_pO2u",x="sidebarItemList_Yudw",v="sidebarItem__DBe",j="sidebarItemLink_mo7H",b="sidebarItemLinkActive_I1ZP",w="yearGroupHeading_rMGB",N=e=>{let{items:t}=e;return(0,m.jsx)(o.OU,{items:t,ulClassName:(0,s.A)(x,"clean-list"),liClassName:v,linkClassName:j,linkActiveClassName:b})};function k(e){let{sidebar:t}=e;const a=(0,o.Gx)(t.items);return(0,m.jsx)("aside",{className:"col col--3",children:(0,m.jsxs)("nav",{className:(0,s.A)(p,"thin-scrollbar"),"aria-label":(0,i.T)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"}),children:[(0,m.jsx)("div",{className:(0,s.A)(f,"margin-bottom--md"),children:t.title}),(0,m.jsx)(g,{items:a,ListComponent:N,yearGroupHeadingClassName:w})]})})}const A=(0,n.memo)(k);var M=a(5600);const _={yearGroupHeading:"yearGroupHeading_QT03"},C=e=>{let{items:t}=e;return(0,m.jsx)(o.OU,{items:t,ulClassName:"menu__list",liClassName:"menu__list-item",linkClassName:"menu__link",linkActiveClassName:"menu__link--active"})};function y(e){let{sidebar:t}=e;const a=(0,o.Gx)(t.items);return(0,m.jsx)(g,{items:a,ListComponent:C,yearGroupHeadingClassName:_.yearGroupHeading})}function P(e){return(0,m.jsx)(M.GX,{component:y,props:e})}const B=(0,n.memo)(P);function I(e){let{sidebar:t}=e;const a=(0,l.l)();return t?.items.length?"mobile"===a?(0,m.jsx)(B,{sidebar:t}):(0,m.jsx)(A,{sidebar:t}):null}function L(e){const{sidebar:t,toc:a,children:n,...l}=e,i=t&&t.items.length>0;return(0,m.jsx)(r.A,{...l,children:(0,m.jsx)("div",{className:"container margin-vert--lg",children:(0,m.jsxs)("div",{className:"row",children:[(0,m.jsx)(I,{sidebar:t}),(0,m.jsx)("main",{className:(0,s.A)("col",{"col--7":i,"col--9 col--offset-1":!i}),children:n}),a&&(0,m.jsx)("div",{className:"col col--2",children:a})]})})})}},5846:(e,t,a)=>{a.d(t,{W:()=>c});var n=a(6540),s=a(4586);const r=["zero","one","two","few","many","other"];function l(e){return r.filter((t=>e.includes(t)))}const i={locale:"en",pluralForms:l(["one","other"]),select:e=>1===e?"one":"other"};function o(){const{i18n:{currentLocale:e}}=(0,s.A)();return(0,n.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:l(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return console.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),i}}),[e])}function c(){const e=o();return{selectMessage:(t,a)=>function(e,t,a){const n=e.split("|");if(1===n.length)return n[0];n.length>a.pluralForms.length&&console.error(`For locale=${a.locale}, a maximum of ${a.pluralForms.length} plural forms are expected (${a.pluralForms.join(",")}), but the message contains ${n.length}: ${e}`);const s=a.select(t),r=a.pluralForms.indexOf(s);return n[Math.min(r,n.length-1)]}(a,t,e)}}}}]); \ No newline at end of file diff --git a/assets/js/3486d072.35bab741.js b/assets/js/3486d072.35bab741.js new file mode 100644 index 0000000000..d5cc580a73 --- /dev/null +++ b/assets/js/3486d072.35bab741.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3003],{7708:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>i});var t=r(4848),c=r(8453);const o={},a="controllers/patch_manager",s={id:"reference/controllers/patch_manager/index",title:"controllers/patch\\_manager",description:"Index",source:"@site/docs/reference/controllers/patch_manager/index.md",sourceDirName:"reference/controllers/patch_manager",slug:"/reference/controllers/patch_manager/",permalink:"/docs/reference/controllers/patch_manager/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot"},next:{title:"Function: earlyInjectionCheck()",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck"}},l={},i=[{value:"Index",id:"index",level:2},{value:"Functions",id:"functions",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"controllerspatch_manager",children:"controllers/patch_manager"})}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",children:"earlyInjectionCheck"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",children:"getAndInjectLicense"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>s});var t=r(6540);const c={},o=t.createContext(c);function a(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3486d072.dc080a37.js b/assets/js/3486d072.dc080a37.js deleted file mode 100644 index a352306582..0000000000 --- a/assets/js/3486d072.dc080a37.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3003],{7708:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>i});var t=r(4848),c=r(8453);const o={},a="controllers/patch_manager",s={id:"reference/controllers/patch_manager/index",title:"controllers/patch\\_manager",description:"Index",source:"@site/docs/reference/controllers/patch_manager/index.md",sourceDirName:"reference/controllers/patch_manager",slug:"/reference/controllers/patch_manager/",permalink:"/docs/reference/controllers/patch_manager/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: screenshot",permalink:"/docs/reference/controllers/initializer/variables/screenshot"},next:{title:"Function: earlyInjectionCheck()",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck"}},l={},i=[{value:"Index",id:"index",level:2},{value:"Functions",id:"functions",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"controllerspatch_manager",children:"controllers/patch_manager"}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",children:"earlyInjectionCheck"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",children:"getAndInjectLicense"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>s});var t=r(6540);const c={},o=t.createContext(c);function a(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/393be207.2acfc4f8.js b/assets/js/393be207.2acfc4f8.js new file mode 100644 index 0000000000..cae5276e3d --- /dev/null +++ b/assets/js/393be207.2acfc4f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4134],{633:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(4848),a=t(8453);const r={title:"Markdown page example"},s="Markdown page example",c={type:"mdx",permalink:"/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},p={},d=[];function i(e){const n={h1:"h1",header:"header",p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"})}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const a={},r=o.createContext(a);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/393be207.a0ef7dd4.js b/assets/js/393be207.a0ef7dd4.js deleted file mode 100644 index 9a19dd290b..0000000000 --- a/assets/js/393be207.a0ef7dd4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4134],{633:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var o=t(4848),a=t(8453);const r={title:"Markdown page example"},s="Markdown page example",p={type:"mdx",permalink:"/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},c={},d=[];function i(e){const n={h1:"h1",p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>p});var o=t(6540);const a={},r=o.createContext(a);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function p(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3bb4bcf6.40529326.js b/assets/js/3bb4bcf6.40529326.js new file mode 100644 index 0000000000..30116ef9a6 --- /dev/null +++ b/assets/js/3bb4bcf6.40529326.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8223],{4966:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=s(4848),l=s(8453);const o={},t="Interface: PollVote",i={id:"reference/api/model/message/interfaces/PollVote",title:"Interface: PollVote",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollVote.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollVote.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption"},next:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"ack",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"pollOptions",id:"polloptions",level:3},{value:"selectedOptionLocalIds",id:"selectedoptionlocalids",level:3},{value:"selectedOptionValues",id:"selectedoptionvalues",level:3},{value:"sender",id:"sender",level:3},{value:"senderObj",id:"senderobj",level:3},{value:"senderTimestampMs",id:"sendertimestampms",level:3},{value:"stale",id:"stale",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-pollvote",children:"Interface: PollVote"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of this vote. For some reason this is different from the msgKey and includes exclamaition marks."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message key of this vote"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The Message ID of the original Poll message"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"polloptions",children:"pollOptions"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"pollOptions"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,r.jsx)(n.code,{children:"PollOption"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The original poll options available on the poll"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"selectedoptionlocalids",children:"selectedOptionLocalIds"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"selectedOptionLocalIds"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The selected option IDs of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"selectedoptionvalues",children:"selectedOptionValues"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"selectedOptionValues"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The selected option values by this voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sender",children:"sender"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"sender"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderobj",children:"senderObj"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderObj"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact object of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sendertimestampms",children:"senderTimestampMs"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderTimestampMs"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Timestamp of the vote"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stale",children:"stale"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stale"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>i});var r=s(6540);const l={},o=r.createContext(l);function t(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3bb4bcf6.cc1ea699.js b/assets/js/3bb4bcf6.cc1ea699.js deleted file mode 100644 index 5eb38cff08..0000000000 --- a/assets/js/3bb4bcf6.cc1ea699.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8223],{4966:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=s(4848),l=s(8453);const o={},t="Interface: PollVote",i={id:"reference/api/model/message/interfaces/PollVote",title:"Interface: PollVote",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollVote.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollVote.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption"},next:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"ack",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"pollOptions",id:"polloptions",level:3},{value:"selectedOptionLocalIds",id:"selectedoptionlocalids",level:3},{value:"selectedOptionValues",id:"selectedoptionvalues",level:3},{value:"sender",id:"sender",level:3},{value:"senderObj",id:"senderobj",level:3},{value:"senderTimestampMs",id:"sendertimestampms",level:3},{value:"stale",id:"stale",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-pollvote",children:"Interface: PollVote"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of this vote. For some reason this is different from the msgKey and includes exclamaition marks."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message key of this vote"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The Message ID of the original Poll message"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"polloptions",children:"pollOptions"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"pollOptions"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,r.jsx)(n.code,{children:"PollOption"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The original poll options available on the poll"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"selectedoptionlocalids",children:"selectedOptionLocalIds"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"selectedOptionLocalIds"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The selected option IDs of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"selectedoptionvalues",children:"selectedOptionValues"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"selectedOptionValues"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The selected option values by this voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sender",children:"sender"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"sender"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderobj",children:"senderObj"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderObj"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact object of the voter"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sendertimestampms",children:"senderTimestampMs"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderTimestampMs"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Timestamp of the vote"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stale",children:"stale"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stale"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>i});var r=s(6540);const l={},o=r.createContext(l);function t(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3d3a9b6d.b5add715.js b/assets/js/3d3a9b6d.b5add715.js deleted file mode 100644 index f86c8bbfa4..0000000000 --- a/assets/js/3d3a9b6d.b5add715.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1181],{3826:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>a});var i=r(4848),t=r(8453);const l={},c="controllers/initializer",s={id:"reference/controllers/initializer/index",title:"controllers/initializer",description:"Index",source:"@site/docs/reference/controllers/initializer/index.md",sourceDirName:"reference/controllers/initializer",slug:"/reference/controllers/initializer/",permalink:"/docs/reference/controllers/initializer/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/init\\_patch",permalink:"/docs/reference/controllers/init_patch/"},next:{title:"Function: create()",permalink:"/docs/reference/controllers/initializer/functions/create"}},o={},a=[{value:"Index",id:"index",level:2},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"controllersinitializer",children:"controllers/initializer"}),"\n",(0,i.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/configWithCases",children:"configWithCases"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/pkg",children:"pkg"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/screenshot",children:"screenshot"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/functions/create",children:"create"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/functions/timeout",children:"timeout"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>s});var i=r(6540);const t={},l=i.createContext(t);function c(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3d3a9b6d.c397b34f.js b/assets/js/3d3a9b6d.c397b34f.js new file mode 100644 index 0000000000..4c4c22af21 --- /dev/null +++ b/assets/js/3d3a9b6d.c397b34f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1181],{3826:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>a});var i=r(4848),t=r(8453);const l={},c="controllers/initializer",s={id:"reference/controllers/initializer/index",title:"controllers/initializer",description:"Index",source:"@site/docs/reference/controllers/initializer/index.md",sourceDirName:"reference/controllers/initializer",slug:"/reference/controllers/initializer/",permalink:"/docs/reference/controllers/initializer/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/init\\_patch",permalink:"/docs/reference/controllers/init_patch/"},next:{title:"Function: create()",permalink:"/docs/reference/controllers/initializer/functions/create"}},o={},a=[{value:"Index",id:"index",level:2},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"controllersinitializer",children:"controllers/initializer"})}),"\n",(0,i.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/configWithCases",children:"configWithCases"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/pkg",children:"pkg"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/variables/screenshot",children:"screenshot"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/functions/create",children:"create"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/controllers/initializer/functions/timeout",children:"timeout"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>s});var i=r(6540);const t={},l=i.createContext(t);function c(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3de6a3bc.3845e35b.js b/assets/js/3de6a3bc.3845e35b.js deleted file mode 100644 index c5e380c474..0000000000 --- a/assets/js/3de6a3bc.3845e35b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9178],{8566:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var i=s(4848),l=s(8453);const r={},c="Interface: Contact",d={id:"reference/api/model/contact/interfaces/Contact",title:"Interface: Contact",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/Contact.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/Contact.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile"},next:{title:"Interface: NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"businessProfile?",id:"businessprofile",level:3},{value:"formattedName",id:"formattedname",level:3},{value:"id",id:"id",level:3},{value:"isBusiness",id:"isbusiness",level:3},{value:"isEnterprise",id:"isenterprise",level:3},{value:"isMe",id:"isme",level:3},{value:"isMyContact",id:"ismycontact",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"isPSA",id:"ispsa",level:3},{value:"isUser",id:"isuser",level:3},{value:"isWAContact",id:"iswacontact",level:3},{value:"labels",id:"labels",level:3},{value:"lastSeen?",id:"lastseen",level:3},{value:"msgs",id:"msgs",level:3},{value:"name",id:"name",level:3},{value:"plaintextDisabled",id:"plaintextdisabled",level:3},{value:"profilePicThumbObj",id:"profilepicthumbobj",level:3},{value:"eurl",id:"eurl",level:4},{value:"id",id:"id-1",level:4},{value:"img",id:"img",level:4},{value:"imgFull",id:"imgfull",level:4},{value:"raw",id:"raw",level:4},{value:"tag",id:"tag",level:4},{value:"pushname",id:"pushname",level:3},{value:"shortName",id:"shortname",level:3},{value:"statusMute",id:"statusmute",level:3},{value:"type",id:"type",level:3},{value:"verifiedLevel",id:"verifiedlevel",level:3},{value:"verifiedName",id:"verifiedname",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-contact",children:"Interface: Contact"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"businessprofile",children:"businessProfile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"businessProfile"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,i.jsx)(n.code,{children:"BusinessProfile"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the contact is a business, the business information will be added to the contact object."}),"\n",(0,i.jsxs)(n.p,{children:["In some circumstances this will be out of date or lacking certain fields. In those cases you have to use ",(0,i.jsx)(n.code,{children:"client.getBusinessProfile"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedname",children:"formattedName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"formattedName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isbusiness",children:"isBusiness"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isBusiness"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isenterprise",children:"isEnterprise"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isEnterprise"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Most likely true when the account has a green tick. See ",(0,i.jsx)(n.code,{children:"verifiedLevel"})," also."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isme",children:"isMe"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isMe"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismycontact",children:"isMyContact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isMyContact"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:"isOnline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ispsa",children:"isPSA"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isPSA"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isuser",children:"isUser"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isUser"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iswacontact",children:"isWAContact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isWAContact"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:"lastSeen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(n.code,{children:"Message"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"plaintextdisabled",children:"plaintextDisabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"plaintextDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"profilepicthumbobj",children:"profilePicThumbObj"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"profilePicThumbObj"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"eurl",children:"eurl"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eurl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:(0,i.jsx)(n.code,{children:"Id"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"img",children:"img"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"img"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"imgfull",children:"imgFull"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"imgFull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"raw",children:"raw"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"raw"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tag",children:"tag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pushname",children:"pushname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shortname",children:"shortName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"shortName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"statusmute",children:"statusMute"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"statusMute"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"verifiedlevel",children:"verifiedLevel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"verifiedLevel"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"0 = not verified\n2 = verified (most likely represents a blue tick)"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"verifiedname",children:"verifiedName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"verifiedName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The business account name verified by WA."})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>d});var i=s(6540);const l={},r=i.createContext(l);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3de6a3bc.879d8e03.js b/assets/js/3de6a3bc.879d8e03.js new file mode 100644 index 0000000000..a9cf054f63 --- /dev/null +++ b/assets/js/3de6a3bc.879d8e03.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9178],{8566:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var i=s(4848),l=s(8453);const r={},c="Interface: Contact",d={id:"reference/api/model/contact/interfaces/Contact",title:"Interface: Contact",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/Contact.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/Contact.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile"},next:{title:"Interface: NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"businessProfile?",id:"businessprofile",level:3},{value:"formattedName",id:"formattedname",level:3},{value:"id",id:"id",level:3},{value:"isBusiness",id:"isbusiness",level:3},{value:"isEnterprise",id:"isenterprise",level:3},{value:"isMe",id:"isme",level:3},{value:"isMyContact",id:"ismycontact",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"isPSA",id:"ispsa",level:3},{value:"isUser",id:"isuser",level:3},{value:"isWAContact",id:"iswacontact",level:3},{value:"labels",id:"labels",level:3},{value:"lastSeen?",id:"lastseen",level:3},{value:"msgs",id:"msgs",level:3},{value:"name",id:"name",level:3},{value:"plaintextDisabled",id:"plaintextdisabled",level:3},{value:"profilePicThumbObj",id:"profilepicthumbobj",level:3},{value:"eurl",id:"eurl",level:4},{value:"id",id:"id-1",level:4},{value:"img",id:"img",level:4},{value:"imgFull",id:"imgfull",level:4},{value:"raw",id:"raw",level:4},{value:"tag",id:"tag",level:4},{value:"pushname",id:"pushname",level:3},{value:"shortName",id:"shortname",level:3},{value:"statusMute",id:"statusmute",level:3},{value:"type",id:"type",level:3},{value:"verifiedLevel",id:"verifiedlevel",level:3},{value:"verifiedName",id:"verifiedname",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-contact",children:"Interface: Contact"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"businessprofile",children:"businessProfile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"businessProfile"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,i.jsx)(n.code,{children:"BusinessProfile"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the contact is a business, the business information will be added to the contact object."}),"\n",(0,i.jsxs)(n.p,{children:["In some circumstances this will be out of date or lacking certain fields. In those cases you have to use ",(0,i.jsx)(n.code,{children:"client.getBusinessProfile"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedname",children:"formattedName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"formattedName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isbusiness",children:"isBusiness"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isBusiness"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isenterprise",children:"isEnterprise"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isEnterprise"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Most likely true when the account has a green tick. See ",(0,i.jsx)(n.code,{children:"verifiedLevel"})," also."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isme",children:"isMe"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isMe"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismycontact",children:"isMyContact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isMyContact"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:"isOnline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ispsa",children:"isPSA"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isPSA"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isuser",children:"isUser"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isUser"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iswacontact",children:"isWAContact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isWAContact"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:"lastSeen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(n.code,{children:"Message"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"plaintextdisabled",children:"plaintextDisabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"plaintextDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"profilepicthumbobj",children:"profilePicThumbObj"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"profilePicThumbObj"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"eurl",children:"eurl"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eurl"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/id/interfaces/Id",children:(0,i.jsx)(n.code,{children:"Id"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"img",children:"img"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"img"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"imgfull",children:"imgFull"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"imgFull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"raw",children:"raw"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"raw"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tag",children:"tag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pushname",children:"pushname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shortname",children:"shortName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"shortName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"statusmute",children:"statusMute"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"statusMute"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"verifiedlevel",children:"verifiedLevel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"verifiedLevel"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"0 = not verified\n2 = verified (most likely represents a blue tick)"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"verifiedname",children:"verifiedName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"verifiedName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The business account name verified by WA."})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>d});var i=s(6540);const l={},r=i.createContext(l);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3edf7b61.0d117889.js b/assets/js/3edf7b61.0d117889.js deleted file mode 100644 index 1fd50c6c7b..0000000000 --- a/assets/js/3edf7b61.0d117889.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2801],{6374:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>r,toc:()=>c});var a=s(4848),i=s(8453);const n={},l="Type Alias: FilePath",r={id:"reference/api/model/aliases/type-aliases/FilePath",title:"Type Alias: FilePath",description:"FilePath: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/FilePath.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/FilePath.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL"},next:{title:"Type Alias: GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL"}},o={},c=[];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-filepath",children:"Type Alias: FilePath"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"FilePath"}),": ",(0,a.jsx)(t.code,{children:"Brand"}),"<",(0,a.jsx)(t.code,{children:"string"}),", ",(0,a.jsx)(t.code,{children:'"FilePath"'}),">"]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"The relative or absolute path of a file"}),"\n",(0,a.jsxs)(t.p,{children:["Learn more here: ",(0,a.jsx)(t.a,{href:"https://www.w3schools.com/html/html_filepaths.asp",children:"https://www.w3schools.com/html/html_filepaths.asp"})]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>l,x:()=>r});var a=s(6540);const i={},n=a.createContext(i);function l(e){const t=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3edf7b61.8e14edf3.js b/assets/js/3edf7b61.8e14edf3.js new file mode 100644 index 0000000000..8cdcb14ff6 --- /dev/null +++ b/assets/js/3edf7b61.8e14edf3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2801],{6374:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>n,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=s(4848),i=s(8453);const r={},n="Type Alias: FilePath",l={id:"reference/api/model/aliases/type-aliases/FilePath",title:"Type Alias: FilePath",description:"FilePath: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/FilePath.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/FilePath.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL"},next:{title:"Type Alias: GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL"}},o={},c=[];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"type-alias-filepath",children:"Type Alias: FilePath"})}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"FilePath"}),": ",(0,a.jsx)(t.code,{children:"Brand"}),"<",(0,a.jsx)(t.code,{children:"string"}),", ",(0,a.jsx)(t.code,{children:'"FilePath"'}),">"]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"The relative or absolute path of a file"}),"\n",(0,a.jsxs)(t.p,{children:["Learn more here: ",(0,a.jsx)(t.a,{href:"https://www.w3schools.com/html/html_filepaths.asp",children:"https://www.w3schools.com/html/html_filepaths.asp"})]})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>n,x:()=>l});var a=s(6540);const i={},r=a.createContext(i);function n(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/402fd8ec.2a92274b.js b/assets/js/402fd8ec.2a92274b.js new file mode 100644 index 0000000000..ec403bcbd1 --- /dev/null +++ b/assets/js/402fd8ec.2a92274b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2007],{5434:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=r(4848),s=r(8453);const t={},o="Enumeration: QRQuality",c={id:"reference/api/model/config/enumerations/QRQuality",title:"Enumeration: QRQuality",description:"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.",source:"@site/docs/reference/api/model/config/enumerations/QRQuality.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/QRQuality.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat"},next:{title:"Interface: ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject"}},l={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"EIGHT",id:"eight",level:3},{value:"FIVE",id:"five",level:3},{value:"FOUR",id:"four",level:3},{value:"NINE",id:"nine",level:3},{value:"ONE",id:"one",level:3},{value:"SEVEN",id:"seven",level:3},{value:"SIX",id:"six",level:3},{value:"TEN",id:"ten",level:3},{value:"THREE",id:"three",level:3},{value:"TWO",id:"two",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"enumeration-qrquality",children:"Enumeration: QRQuality"})}),"\n",(0,i.jsx)(n.p,{children:"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality."}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsx)(n.h3,{id:"eight",children:"EIGHT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EIGHT"}),": ",(0,i.jsx)(n.code,{children:"0.8"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"five",children:"FIVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FIVE"}),": ",(0,i.jsx)(n.code,{children:"0.5"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"four",children:"FOUR"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FOUR"}),": ",(0,i.jsx)(n.code,{children:"0.4"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nine",children:"NINE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NINE"}),": ",(0,i.jsx)(n.code,{children:"0.9"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"one",children:"ONE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ONE"}),": ",(0,i.jsx)(n.code,{children:"0.1"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"seven",children:"SEVEN"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SEVEN"}),": ",(0,i.jsx)(n.code,{children:"0.7"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"six",children:"SIX"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SIX"}),": ",(0,i.jsx)(n.code,{children:"0.6"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ten",children:"TEN"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TEN"}),": ",(0,i.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"three",children:"THREE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"THREE"}),": ",(0,i.jsx)(n.code,{children:"0.3"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"two",children:"TWO"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TWO"}),": ",(0,i.jsx)(n.code,{children:"0.2"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var i=r(6540);const s={},t=i.createContext(s);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/402fd8ec.32c2a32b.js b/assets/js/402fd8ec.32c2a32b.js deleted file mode 100644 index d1a0b48024..0000000000 --- a/assets/js/402fd8ec.32c2a32b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2007],{5434:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=r(4848),s=r(8453);const t={},o="Enumeration: QRQuality",c={id:"reference/api/model/config/enumerations/QRQuality",title:"Enumeration: QRQuality",description:"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.",source:"@site/docs/reference/api/model/config/enumerations/QRQuality.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/QRQuality",permalink:"/docs/reference/api/model/config/enumerations/QRQuality",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/QRQuality.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: QRFormat",permalink:"/docs/reference/api/model/config/enumerations/QRFormat"},next:{title:"Interface: ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject"}},l={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"EIGHT",id:"eight",level:3},{value:"FIVE",id:"five",level:3},{value:"FOUR",id:"four",level:3},{value:"NINE",id:"nine",level:3},{value:"ONE",id:"one",level:3},{value:"SEVEN",id:"seven",level:3},{value:"SIX",id:"six",level:3},{value:"TEN",id:"ten",level:3},{value:"THREE",id:"three",level:3},{value:"TWO",id:"two",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"enumeration-qrquality",children:"Enumeration: QRQuality"}),"\n",(0,i.jsx)(n.p,{children:"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality."}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsx)(n.h3,{id:"eight",children:"EIGHT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EIGHT"}),": ",(0,i.jsx)(n.code,{children:"0.8"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"five",children:"FIVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FIVE"}),": ",(0,i.jsx)(n.code,{children:"0.5"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"four",children:"FOUR"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FOUR"}),": ",(0,i.jsx)(n.code,{children:"0.4"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nine",children:"NINE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NINE"}),": ",(0,i.jsx)(n.code,{children:"0.9"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"one",children:"ONE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ONE"}),": ",(0,i.jsx)(n.code,{children:"0.1"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"seven",children:"SEVEN"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SEVEN"}),": ",(0,i.jsx)(n.code,{children:"0.7"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"six",children:"SIX"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SIX"}),": ",(0,i.jsx)(n.code,{children:"0.6"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ten",children:"TEN"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TEN"}),": ",(0,i.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"three",children:"THREE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"THREE"}),": ",(0,i.jsx)(n.code,{children:"0.3"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"two",children:"TWO"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TWO"}),": ",(0,i.jsx)(n.code,{children:"0.2"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var i=r(6540);const s={},t=i.createContext(s);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4197358a.4e882fac.js b/assets/js/4197358a.4e882fac.js deleted file mode 100644 index f1242c80bf..0000000000 --- a/assets/js/4197358a.4e882fac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8867],{6014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=t(4848),i=t(8453);const s={},o="api/model/events",a={id:"reference/api/model/events/index",title:"api/model/events",description:"Index",source:"@site/docs/reference/api/model/events/index.md",sourceDirName:"reference/api/model/events",slug:"/reference/api/model/events/",permalink:"/docs/reference/api/model/events/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/events/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ERROR\\_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME"},next:{title:"Enumeration: SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener"}},c={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodelevents",children:"api/model/events"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4197358a.68e80e67.js b/assets/js/4197358a.68e80e67.js new file mode 100644 index 0000000000..bcf37eaf17 --- /dev/null +++ b/assets/js/4197358a.68e80e67.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8867],{6014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=t(4848),i=t(8453);const s={},o="api/model/events",a={id:"reference/api/model/events/index",title:"api/model/events",description:"Index",source:"@site/docs/reference/api/model/events/index.md",sourceDirName:"reference/api/model/events",slug:"/reference/api/model/events/",permalink:"/docs/reference/api/model/events/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/events/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ERROR\\_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME"},next:{title:"Enumeration: SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener"}},d={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelevents",children:"api/model/events"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/428f4992.41878ef1.js b/assets/js/428f4992.41878ef1.js deleted file mode 100644 index 35d600fe35..0000000000 --- a/assets/js/428f4992.41878ef1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[815],{8183:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>s});var r=t(4848),l=t(8453);const a={},i="api/model/label",c={id:"reference/api/model/label/index",title:"api/model/label",description:"Index",source:"@site/docs/reference/api/model/label/index.md",sourceDirName:"reference/api/model/label",slug:"/reference/api/model/label/",permalink:"/docs/reference/api/model/label/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/label/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Id",permalink:"/docs/reference/api/model/id/interfaces/Id"},next:{title:"Interface: Label",permalink:"/docs/reference/api/model/label/interfaces/Label"}},o={},s=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodellabel",children:"api/model/label"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>c});var r=t(6540);const l={},a=r.createContext(l);function i(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/428f4992.939b9cd9.js b/assets/js/428f4992.939b9cd9.js new file mode 100644 index 0000000000..9f5535f81f --- /dev/null +++ b/assets/js/428f4992.939b9cd9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[815],{8183:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>o});var t=r(4848),a=r(8453);const l={},i="api/model/label",c={id:"reference/api/model/label/index",title:"api/model/label",description:"Index",source:"@site/docs/reference/api/model/label/index.md",sourceDirName:"reference/api/model/label",slug:"/reference/api/model/label/",permalink:"/docs/reference/api/model/label/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/label/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Id",permalink:"/docs/reference/api/model/id/interfaces/Id"},next:{title:"Interface: Label",permalink:"/docs/reference/api/model/label/interfaces/Label"}},d={},o=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function s(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"apimodellabel",children:"api/model/label"})}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(s,{...e})}):s(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var t=r(6540);const a={},l=t.createContext(a);function i(e){const n=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/437a86f0.14700e56.js b/assets/js/437a86f0.14700e56.js new file mode 100644 index 0000000000..19434bd907 --- /dev/null +++ b/assets/js/437a86f0.14700e56.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3272],{4470:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=t(4848),c=t(8453);const i={},a="Type Alias: ReactionEvent",r={id:"reference/api/model/reactions/type-aliases/ReactionEvent",title:"Type Alias: ReactionEvent",description:"ReactionEvent: object",source:"@site/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction"},next:{title:"Type Alias: ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord"}},o={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"message",id:"message",level:3},{value:"reactionByMe",id:"reactionbyme",level:3},{value:"reactions",id:"reactions",level:3},{value:"type",id:"type",level:3}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"type-alias-reactionevent",children:"Type Alias: ReactionEvent"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ReactionEvent"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Emitted by onReaction"}),"\n",(0,s.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(n.code,{children:"Message"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The message being reacted to"}),"\n",(0,s.jsx)(n.h3,{id:"reactionbyme",children:"reactionByMe"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reactionByMe"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:(0,s.jsx)(n.code,{children:"Reaction"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The reaction sent by the host account"}),"\n",(0,s.jsx)(n.h3,{id:"reactions",children:"reactions"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reactions"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:(0,s.jsx)(n.code,{children:"Reaction"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An array of all reactions"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:'"add"'})," | ",(0,s.jsx)(n.code,{children:'"change"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The type of the reaction event."})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(6540);const c={},i=s.createContext(c);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/437a86f0.abc4fc76.js b/assets/js/437a86f0.abc4fc76.js deleted file mode 100644 index cb4f93476f..0000000000 --- a/assets/js/437a86f0.abc4fc76.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3272],{4470:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var s=t(4848),c=t(8453);const i={},o="Type Alias: ReactionEvent",a={id:"reference/api/model/reactions/type-aliases/ReactionEvent",title:"Type Alias: ReactionEvent",description:"ReactionEvent: object",source:"@site/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction"},next:{title:"Type Alias: ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord"}},r={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"message",id:"message",level:3},{value:"reactionByMe",id:"reactionbyme",level:3},{value:"reactions",id:"reactions",level:3},{value:"type",id:"type",level:3}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-reactionevent",children:"Type Alias: ReactionEvent"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ReactionEvent"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Emitted by onReaction"}),"\n",(0,s.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(n.code,{children:"Message"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The message being reacted to"}),"\n",(0,s.jsx)(n.h3,{id:"reactionbyme",children:"reactionByMe"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reactionByMe"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:(0,s.jsx)(n.code,{children:"Reaction"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The reaction sent by the host account"}),"\n",(0,s.jsx)(n.h3,{id:"reactions",children:"reactions"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reactions"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:(0,s.jsx)(n.code,{children:"Reaction"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An array of all reactions"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:'"add"'})," | ",(0,s.jsx)(n.code,{children:'"change"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The type of the reaction event."})]})}function p(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const c={},i=s.createContext(c);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/45205a09.5ac75869.js b/assets/js/45205a09.5ac75869.js deleted file mode 100644 index 8fa5e61e66..0000000000 --- a/assets/js/45205a09.5ac75869.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1359],{7112:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>m,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var t=r(4848),o=r(8453);const a={},i="Enumeration: groupChangeEvent",s={id:"reference/api/model/group-metadata/enumerations/groupChangeEvent",title:"Enumeration: groupChangeEvent",description:"Enumeration Members",source:"@site/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",sourceDirName:"reference/api/model/group-metadata/enumerations",slug:"/reference/api/model/group-metadata/enumerations/groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes"},next:{title:"Interface: GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"add",id:"add",level:3},{value:"remove",id:"remove",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-groupchangeevent",children:"Enumeration: groupChangeEvent"}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"add",children:"add"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"add"}),": ",(0,t.jsx)(n.code,{children:'"add"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"remove",children:"remove"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"remove"}),": ",(0,t.jsx)(n.code,{children:'"remove"'})]}),"\n"]})]})}function m(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>s});var t=r(6540);const o={},a=t.createContext(o);function i(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/45205a09.6ba92497.js b/assets/js/45205a09.6ba92497.js new file mode 100644 index 0000000000..4cfaad5908 --- /dev/null +++ b/assets/js/45205a09.6ba92497.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1359],{7112:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var t=r(4848),o=r(8453);const a={},i="Enumeration: groupChangeEvent",s={id:"reference/api/model/group-metadata/enumerations/groupChangeEvent",title:"Enumeration: groupChangeEvent",description:"Enumeration Members",source:"@site/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",sourceDirName:"reference/api/model/group-metadata/enumerations",slug:"/reference/api/model/group-metadata/enumerations/groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes"},next:{title:"Interface: GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent"}},d={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"add",id:"add",level:3},{value:"remove",id:"remove",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"enumeration-groupchangeevent",children:"Enumeration: groupChangeEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"add",children:"add"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"add"}),": ",(0,t.jsx)(n.code,{children:'"add"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"remove",children:"remove"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"remove"}),": ",(0,t.jsx)(n.code,{children:'"remove"'})]}),"\n"]})]})}function m(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>s});var t=r(6540);const o={},a=t.createContext(o);function i(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4640f537.cbff63bb.js b/assets/js/4640f537.e01f4009.js similarity index 54% rename from assets/js/4640f537.cbff63bb.js rename to assets/js/4640f537.e01f4009.js index d322d616d6..d2f7fc58f4 100644 --- a/assets/js/4640f537.cbff63bb.js +++ b/assets/js/4640f537.e01f4009.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8512],{5951:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>a,toc:()=>u});var n=t(4848),s=t(8453);const o={},c="Interface: CurrentDialogProps",a={id:"reference/structures/Dialog/interfaces/CurrentDialogProps",title:"Interface: CurrentDialogProps",description:"Indexable",source:"@site/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType"},next:{title:"Interface: DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons"}},i={},u=[{value:"Indexable",id:"indexable",level:2}];function l(e){const r={code:"code",h1:"h1",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-currentdialogprops",children:"Interface: CurrentDialogProps"}),"\n",(0,n.jsx)(r.h2,{id:"indexable",children:"Indexable"}),"\n",(0,n.jsxs)(r.p,{children:["[",(0,n.jsx)(r.code,{children:"k"}),": ",(0,n.jsx)(r.code,{children:"string"}),"]: ",(0,n.jsx)(r.code,{children:"any"})]})]})}function d(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>a});var n=t(6540);const s={},o=n.createContext(s);function c(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8512],{5951:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>a,toc:()=>u});var n=t(4848),s=t(8453);const o={},c="Interface: CurrentDialogProps",a={id:"reference/structures/Dialog/interfaces/CurrentDialogProps",title:"Interface: CurrentDialogProps",description:"Indexable",source:"@site/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType"},next:{title:"Interface: DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons"}},i={},u=[{value:"Indexable",id:"indexable",level:2}];function l(e){const r={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-currentdialogprops",children:"Interface: CurrentDialogProps"})}),"\n",(0,n.jsx)(r.h2,{id:"indexable",children:"Indexable"}),"\n",(0,n.jsxs)(r.p,{children:["[",(0,n.jsx)(r.code,{children:"k"}),": ",(0,n.jsx)(r.code,{children:"string"}),"]: ",(0,n.jsx)(r.code,{children:"any"})]})]})}function d(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>a});var n=t(6540);const s={},o=n.createContext(s);function c(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/465af148.20f29c9c.js b/assets/js/465af148.20f29c9c.js deleted file mode 100644 index 68ddf1832d..0000000000 --- a/assets/js/465af148.20f29c9c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3268],{1136:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>i,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var t=a(4848),r=a(8453);const n={},o="Type Alias: ChatId",c={id:"reference/api/model/aliases/type-aliases/ChatId",title:"Type Alias: ChatId",description:"ChatId: ContactId \\| GroupChatId",source:"@site/docs/reference/api/model/aliases/type-aliases/ChatId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ChatId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64"},next:{title:"Type Alias: ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer"}},i={},d=[];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"type-alias-chatid",children:"Type Alias: ChatId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"ChatId"}),": ",(0,t.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,t.jsx)(s.code,{children:"ContactId"})})," | ",(0,t.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,t.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["A chat id ends with ",(0,t.jsx)(s.code,{children:"@c.us"})," or ",(0,t.jsx)(s.code,{children:"@g.us"})," for group chats."]}),"\n",(0,t.jsx)(s.p,{children:"Example:"}),"\n",(0,t.jsxs)(s.p,{children:["A group chat: ",(0,t.jsx)(s.code,{children:'"447123456789-1445627445@g.us"'}),"\nA group chat: ",(0,t.jsx)(s.code,{children:'"447123456789@g.us"'})]})]})}function p(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>o,x:()=>c});var t=a(6540);const r={},n=t.createContext(r);function o(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/465af148.5e619ea8.js b/assets/js/465af148.5e619ea8.js new file mode 100644 index 0000000000..9b8684bc72 --- /dev/null +++ b/assets/js/465af148.5e619ea8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3268],{1136:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>i,contentTitle:()=>c,default:()=>p,frontMatter:()=>n,metadata:()=>o,toc:()=>d});var t=a(4848),r=a(8453);const n={},c="Type Alias: ChatId",o={id:"reference/api/model/aliases/type-aliases/ChatId",title:"Type Alias: ChatId",description:"ChatId: ContactId \\| GroupChatId",source:"@site/docs/reference/api/model/aliases/type-aliases/ChatId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ChatId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64"},next:{title:"Type Alias: ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer"}},i={},d=[];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"type-alias-chatid",children:"Type Alias: ChatId"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"ChatId"}),": ",(0,t.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,t.jsx)(s.code,{children:"ContactId"})})," | ",(0,t.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,t.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["A chat id ends with ",(0,t.jsx)(s.code,{children:"@c.us"})," or ",(0,t.jsx)(s.code,{children:"@g.us"})," for group chats."]}),"\n",(0,t.jsx)(s.p,{children:"Example:"}),"\n",(0,t.jsxs)(s.p,{children:["A group chat: ",(0,t.jsx)(s.code,{children:'"447123456789-1445627445@g.us"'}),"\nA group chat: ",(0,t.jsx)(s.code,{children:'"447123456789@g.us"'})]})]})}function p(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>c,x:()=>o});var t=a(6540);const r={},n=t.createContext(r);function c(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4689dc6f.3fc0e36c.js b/assets/js/4689dc6f.3fc0e36c.js deleted file mode 100644 index ac25485693..0000000000 --- a/assets/js/4689dc6f.3fc0e36c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1939],{3521:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var t=r(4848),c=r(8453);const o={},d="Interface: GenericGroupChangeEvent",i={id:"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",title:"Interface: GenericGroupChangeEvent",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent"},next:{title:"Interface: GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata"}},s={},a=[{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"body",id:"body",level:3},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"groupPic",id:"grouppic",level:3},{value:"id",id:"id",level:3},{value:"type",id:"type",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-genericgroupchangeevent",children:"Interface: GenericGroupChangeEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"author",children:"author"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"author"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,t.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The contact who triggered this event. (E.g the contact who changed the group picture)"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"body",children:"body"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Some more information about the event"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,t.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"grouppic",children:"groupPic"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"groupPic"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Base 64 encoded image"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,t.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"remove"'})," | ",(0,t.jsx)(n.code,{children:'"add"'})," | ",(0,t.jsx)(n.code,{children:'"invite"'})," | ",(0,t.jsx)(n.code,{children:'"leave"'})," | ",(0,t.jsx)(n.code,{children:'"subject"'})," | ",(0,t.jsx)(n.code,{children:'"description"'})," | ",(0,t.jsx)(n.code,{children:'"announce"'})," | ",(0,t.jsx)(n.code,{children:'"restrict"'})," | ",(0,t.jsx)(n.code,{children:'"picutre"'})," | ",(0,t.jsx)(n.code,{children:'"create"'})," | ",(0,t.jsx)(n.code,{children:'"delete"'})," | ",(0,t.jsx)(n.code,{children:'"revoke_invite"'})," | ",(0,t.jsx)(n.code,{children:'"no_frequently_forwarded"'})," | ",(0,t.jsx)(n.code,{children:'"announce_msg_bounce"'})," | ",(0,t.jsx)(n.code,{children:'"demote"'})," | ",(0,t.jsx)(n.code,{children:'"promote"'})," | ",(0,t.jsx)(n.code,{children:'"modify"'})," | ",(0,t.jsx)(n.code,{children:'"v4_add_invite_sent"'})," | ",(0,t.jsx)(n.code,{children:'"v4_add_invite_join"'})," | ",(0,t.jsx)(n.code,{children:'"growth_locked"'})," | ",(0,t.jsx)(n.code,{children:'"growth_unlocked"'})," | ",(0,t.jsx)(n.code,{children:'"linked_group_join"'})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Type of the event"})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>i});var t=r(6540);const c={},o=t.createContext(c);function d(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4689dc6f.f387a73a.js b/assets/js/4689dc6f.f387a73a.js new file mode 100644 index 0000000000..50b329ab57 --- /dev/null +++ b/assets/js/4689dc6f.f387a73a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1939],{3521:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var t=r(4848),c=r(8453);const o={},d="Interface: GenericGroupChangeEvent",i={id:"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",title:"Interface: GenericGroupChangeEvent",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent"},next:{title:"Interface: GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata"}},a={},s=[{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"body",id:"body",level:3},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"groupPic",id:"grouppic",level:3},{value:"id",id:"id",level:3},{value:"type",id:"type",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-genericgroupchangeevent",children:"Interface: GenericGroupChangeEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"author",children:"author"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"author"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,t.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The contact who triggered this event. (E.g the contact who changed the group picture)"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"body",children:"body"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Some more information about the event"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,t.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"grouppic",children:"groupPic"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"groupPic"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Base 64 encoded image"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,t.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"remove"'})," | ",(0,t.jsx)(n.code,{children:'"add"'})," | ",(0,t.jsx)(n.code,{children:'"invite"'})," | ",(0,t.jsx)(n.code,{children:'"leave"'})," | ",(0,t.jsx)(n.code,{children:'"subject"'})," | ",(0,t.jsx)(n.code,{children:'"description"'})," | ",(0,t.jsx)(n.code,{children:'"announce"'})," | ",(0,t.jsx)(n.code,{children:'"restrict"'})," | ",(0,t.jsx)(n.code,{children:'"picutre"'})," | ",(0,t.jsx)(n.code,{children:'"create"'})," | ",(0,t.jsx)(n.code,{children:'"delete"'})," | ",(0,t.jsx)(n.code,{children:'"revoke_invite"'})," | ",(0,t.jsx)(n.code,{children:'"no_frequently_forwarded"'})," | ",(0,t.jsx)(n.code,{children:'"announce_msg_bounce"'})," | ",(0,t.jsx)(n.code,{children:'"demote"'})," | ",(0,t.jsx)(n.code,{children:'"promote"'})," | ",(0,t.jsx)(n.code,{children:'"modify"'})," | ",(0,t.jsx)(n.code,{children:'"v4_add_invite_sent"'})," | ",(0,t.jsx)(n.code,{children:'"v4_add_invite_join"'})," | ",(0,t.jsx)(n.code,{children:'"growth_locked"'})," | ",(0,t.jsx)(n.code,{children:'"growth_unlocked"'})," | ",(0,t.jsx)(n.code,{children:'"linked_group_join"'})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Type of the event"})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>i});var t=r(6540);const c={},o=t.createContext(c);function d(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/468b357e.baee9306.js b/assets/js/468b357e.baee9306.js deleted file mode 100644 index a36d5040e6..0000000000 --- a/assets/js/468b357e.baee9306.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6315],{5138:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=s(4848),n=s(8453);const r={},i="Type Alias: GetURL",o={id:"reference/api/model/aliases/type-aliases/GetURL",title:"Type Alias: GetURL",description:"GetURL: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/GetURL.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GetURL.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath"},next:{title:"Type Alias: GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-geturl",children:"Type Alias: GetURL"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"GetURL"}),": ",(0,a.jsx)(t.code,{children:"Brand"}),"<",(0,a.jsx)(t.code,{children:"string"}),", ",(0,a.jsx)(t.code,{children:'"GetURL"'}),">"]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"A URL of a file used with a GET request"})]})}function p(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>o});var a=s(6540);const n={},r=a.createContext(n);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/468b357e.d4659f6f.js b/assets/js/468b357e.d4659f6f.js new file mode 100644 index 0000000000..ed14d836b7 --- /dev/null +++ b/assets/js/468b357e.d4659f6f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6315],{5138:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=s(4848),r=s(8453);const n={},i="Type Alias: GetURL",o={id:"reference/api/model/aliases/type-aliases/GetURL",title:"Type Alias: GetURL",description:"GetURL: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/GetURL.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GetURL.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: FilePath",permalink:"/docs/reference/api/model/aliases/type-aliases/FilePath"},next:{title:"Type Alias: GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"type-alias-geturl",children:"Type Alias: GetURL"})}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"GetURL"}),": ",(0,a.jsx)(t.code,{children:"Brand"}),"<",(0,a.jsx)(t.code,{children:"string"}),", ",(0,a.jsx)(t.code,{children:'"GetURL"'}),">"]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"A URL of a file used with a GET request"})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>o});var a=s(6540);const r={},n=a.createContext(r);function i(e){const t=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/484e5a84.4b3ef94d.js b/assets/js/484e5a84.4b3ef94d.js deleted file mode 100644 index 9eee962274..0000000000 --- a/assets/js/484e5a84.4b3ef94d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6956],{6807:(e,c,d)=>{d.r(c),d.d(c,{assets:()=>l,contentTitle:()=>r,default:()=>j,frontMatter:()=>o,metadata:()=>i,toc:()=>h});var s=d(4848),n=d(8453);const o={},r="Type Alias: CountryCode",i={id:"reference/api/model/aliases/type-aliases/CountryCode",title:"Type Alias: CountryCode",description:"CountryCode: 1 \\| 7 \\| 20 \\| 27 \\| 30 \\| 31 \\| 32 \\| 33 \\| 34 \\| 36 \\| 39 \\| 40 \\| 41 \\| 43 \\| 44 \\| 45 \\| 46 \\| 47 \\| 48 \\| 49 \\| 51 \\| 52 \\| 53 \\| 54 \\| 55 \\| 56 \\| 57 \\| 58 \\| 60 \\| 61 \\| 62 \\| 63 \\| 64 \\| 65 \\| 66 \\| 81 \\| 82 \\| 84 \\| 86 \\| 90 \\| 91 \\| 92 \\| 93 \\| 94 \\| 95 \\| 98 \\| 211 \\| 212 \\| 213 \\| 216 \\| 218 \\| 220 \\| 221 \\| 222 \\| 223 \\| 224 \\| 225 \\| 226 \\| 227 \\| 228 \\| 229 \\| 230 \\| 231 \\| 232 \\| 233 \\| 234 \\| 235 \\| 236 \\| 237 \\| 238 \\| 239 \\| 240 \\| 241 \\| 242 \\| 243 \\| 244 \\| 245 \\| 246 \\| 248 \\| 249 \\| 250 \\| 251 \\| 252 \\| 253 \\| 254 \\| 255 \\| 256 \\| 257 \\| 258 \\| 260 \\| 261 \\| 262 \\| 263 \\| 264 \\| 265 \\| 266 \\| 267 \\| 268 \\| 269 \\| 290 \\| 291 \\| 297 \\| 298 \\| 299 \\| 350 \\| 351 \\| 352 \\| 353 \\| 354 \\| 355 \\| 356 \\| 357 \\| 358 \\| 359 \\| 370 \\| 371 \\| 372 \\| 373 \\| 374 \\| 375 \\| 376 \\| 377 \\| 378 \\| 380 \\| 381 \\| 382 \\| 383 \\| 385 \\| 386 \\| 387 \\| 389 \\| 420 \\| 421 \\| 423 \\| 500 \\| 501 \\| 502 \\| 503 \\| 504 \\| 505 \\| 506 \\| 507 \\| 508 \\| 509 \\| 590 \\| 591 \\| 592 \\| 593 \\| 594 \\| 595 \\| 596 \\| 597 \\| 598 \\| 599 \\| 670 \\| 672 \\| 673 \\| 674 \\| 675 \\| 676 \\| 677 \\| 678 \\| 679 \\| 680 \\| 681 \\| 682 \\| 683 \\| 685 \\| 686 \\| 687 \\| 688 \\| 689 \\| 690 \\| 691 \\| 692 \\| 850 \\| 852 \\| 853 \\| 855 \\| 856 \\| 880 \\| 886 \\| 960 \\| 961 \\| 962 \\| 963 \\| 964 \\| 965 \\| 966 \\| 967 \\| 968 \\| 970 \\| 971 \\| 972 \\| 973 \\| 974 \\| 975 \\| 976 \\| 977 \\| 992 \\| 993 \\| 994 \\| 995 \\| 996 \\| 998",source:"@site/docs/reference/api/model/aliases/type-aliases/CountryCode.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/CountryCode.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content"},next:{title:"Type Alias: DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL"}},l={},h=[];function x(e){const c={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(c.h1,{id:"type-alias-countrycode",children:"Type Alias: CountryCode"}),"\n",(0,s.jsxs)(c.blockquote,{children:["\n",(0,s.jsxs)(c.p,{children:[(0,s.jsx)(c.strong,{children:"CountryCode"}),": ",(0,s.jsx)(c.code,{children:"1"})," | ",(0,s.jsx)(c.code,{children:"7"})," | ",(0,s.jsx)(c.code,{children:"20"})," | ",(0,s.jsx)(c.code,{children:"27"})," | ",(0,s.jsx)(c.code,{children:"30"})," | ",(0,s.jsx)(c.code,{children:"31"})," | ",(0,s.jsx)(c.code,{children:"32"})," | ",(0,s.jsx)(c.code,{children:"33"})," | ",(0,s.jsx)(c.code,{children:"34"})," | ",(0,s.jsx)(c.code,{children:"36"})," | ",(0,s.jsx)(c.code,{children:"39"})," | ",(0,s.jsx)(c.code,{children:"40"})," | ",(0,s.jsx)(c.code,{children:"41"})," | ",(0,s.jsx)(c.code,{children:"43"})," | ",(0,s.jsx)(c.code,{children:"44"})," | ",(0,s.jsx)(c.code,{children:"45"})," | ",(0,s.jsx)(c.code,{children:"46"})," | ",(0,s.jsx)(c.code,{children:"47"})," | ",(0,s.jsx)(c.code,{children:"48"})," | ",(0,s.jsx)(c.code,{children:"49"})," | ",(0,s.jsx)(c.code,{children:"51"})," | ",(0,s.jsx)(c.code,{children:"52"})," | ",(0,s.jsx)(c.code,{children:"53"})," | ",(0,s.jsx)(c.code,{children:"54"})," | ",(0,s.jsx)(c.code,{children:"55"})," | ",(0,s.jsx)(c.code,{children:"56"})," | ",(0,s.jsx)(c.code,{children:"57"})," | ",(0,s.jsx)(c.code,{children:"58"})," | ",(0,s.jsx)(c.code,{children:"60"})," | ",(0,s.jsx)(c.code,{children:"61"})," | ",(0,s.jsx)(c.code,{children:"62"})," | ",(0,s.jsx)(c.code,{children:"63"})," | ",(0,s.jsx)(c.code,{children:"64"})," | ",(0,s.jsx)(c.code,{children:"65"})," | ",(0,s.jsx)(c.code,{children:"66"})," | ",(0,s.jsx)(c.code,{children:"81"})," | ",(0,s.jsx)(c.code,{children:"82"})," | ",(0,s.jsx)(c.code,{children:"84"})," | ",(0,s.jsx)(c.code,{children:"86"})," | ",(0,s.jsx)(c.code,{children:"90"})," | ",(0,s.jsx)(c.code,{children:"91"})," | ",(0,s.jsx)(c.code,{children:"92"})," | ",(0,s.jsx)(c.code,{children:"93"})," | ",(0,s.jsx)(c.code,{children:"94"})," | ",(0,s.jsx)(c.code,{children:"95"})," | ",(0,s.jsx)(c.code,{children:"98"})," | ",(0,s.jsx)(c.code,{children:"211"})," | ",(0,s.jsx)(c.code,{children:"212"})," | ",(0,s.jsx)(c.code,{children:"213"})," | ",(0,s.jsx)(c.code,{children:"216"})," | ",(0,s.jsx)(c.code,{children:"218"})," | ",(0,s.jsx)(c.code,{children:"220"})," | ",(0,s.jsx)(c.code,{children:"221"})," | ",(0,s.jsx)(c.code,{children:"222"})," | ",(0,s.jsx)(c.code,{children:"223"})," | ",(0,s.jsx)(c.code,{children:"224"})," | ",(0,s.jsx)(c.code,{children:"225"})," | ",(0,s.jsx)(c.code,{children:"226"})," | ",(0,s.jsx)(c.code,{children:"227"})," | ",(0,s.jsx)(c.code,{children:"228"})," | ",(0,s.jsx)(c.code,{children:"229"})," | ",(0,s.jsx)(c.code,{children:"230"})," | ",(0,s.jsx)(c.code,{children:"231"})," | ",(0,s.jsx)(c.code,{children:"232"})," | ",(0,s.jsx)(c.code,{children:"233"})," | ",(0,s.jsx)(c.code,{children:"234"})," | ",(0,s.jsx)(c.code,{children:"235"})," | ",(0,s.jsx)(c.code,{children:"236"})," | ",(0,s.jsx)(c.code,{children:"237"})," | ",(0,s.jsx)(c.code,{children:"238"})," | ",(0,s.jsx)(c.code,{children:"239"})," | ",(0,s.jsx)(c.code,{children:"240"})," | ",(0,s.jsx)(c.code,{children:"241"})," | ",(0,s.jsx)(c.code,{children:"242"})," | ",(0,s.jsx)(c.code,{children:"243"})," | ",(0,s.jsx)(c.code,{children:"244"})," | ",(0,s.jsx)(c.code,{children:"245"})," | ",(0,s.jsx)(c.code,{children:"246"})," | ",(0,s.jsx)(c.code,{children:"248"})," | ",(0,s.jsx)(c.code,{children:"249"})," | ",(0,s.jsx)(c.code,{children:"250"})," | ",(0,s.jsx)(c.code,{children:"251"})," | ",(0,s.jsx)(c.code,{children:"252"})," | ",(0,s.jsx)(c.code,{children:"253"})," | ",(0,s.jsx)(c.code,{children:"254"})," | ",(0,s.jsx)(c.code,{children:"255"})," | ",(0,s.jsx)(c.code,{children:"256"})," | ",(0,s.jsx)(c.code,{children:"257"})," | ",(0,s.jsx)(c.code,{children:"258"})," | ",(0,s.jsx)(c.code,{children:"260"})," | ",(0,s.jsx)(c.code,{children:"261"})," | ",(0,s.jsx)(c.code,{children:"262"})," | ",(0,s.jsx)(c.code,{children:"263"})," | ",(0,s.jsx)(c.code,{children:"264"})," | ",(0,s.jsx)(c.code,{children:"265"})," | ",(0,s.jsx)(c.code,{children:"266"})," | ",(0,s.jsx)(c.code,{children:"267"})," | ",(0,s.jsx)(c.code,{children:"268"})," | ",(0,s.jsx)(c.code,{children:"269"})," | ",(0,s.jsx)(c.code,{children:"290"})," | ",(0,s.jsx)(c.code,{children:"291"})," | ",(0,s.jsx)(c.code,{children:"297"})," | ",(0,s.jsx)(c.code,{children:"298"})," | ",(0,s.jsx)(c.code,{children:"299"})," | ",(0,s.jsx)(c.code,{children:"350"})," | ",(0,s.jsx)(c.code,{children:"351"})," | ",(0,s.jsx)(c.code,{children:"352"})," | ",(0,s.jsx)(c.code,{children:"353"})," | ",(0,s.jsx)(c.code,{children:"354"})," | ",(0,s.jsx)(c.code,{children:"355"})," | ",(0,s.jsx)(c.code,{children:"356"})," | ",(0,s.jsx)(c.code,{children:"357"})," | ",(0,s.jsx)(c.code,{children:"358"})," | ",(0,s.jsx)(c.code,{children:"359"})," | ",(0,s.jsx)(c.code,{children:"370"})," | ",(0,s.jsx)(c.code,{children:"371"})," | ",(0,s.jsx)(c.code,{children:"372"})," | ",(0,s.jsx)(c.code,{children:"373"})," | ",(0,s.jsx)(c.code,{children:"374"})," | ",(0,s.jsx)(c.code,{children:"375"})," | ",(0,s.jsx)(c.code,{children:"376"})," | ",(0,s.jsx)(c.code,{children:"377"})," | ",(0,s.jsx)(c.code,{children:"378"})," | ",(0,s.jsx)(c.code,{children:"380"})," | ",(0,s.jsx)(c.code,{children:"381"})," | ",(0,s.jsx)(c.code,{children:"382"})," | ",(0,s.jsx)(c.code,{children:"383"})," | ",(0,s.jsx)(c.code,{children:"385"})," | ",(0,s.jsx)(c.code,{children:"386"})," | ",(0,s.jsx)(c.code,{children:"387"})," | ",(0,s.jsx)(c.code,{children:"389"})," | ",(0,s.jsx)(c.code,{children:"420"})," | ",(0,s.jsx)(c.code,{children:"421"})," | ",(0,s.jsx)(c.code,{children:"423"})," | ",(0,s.jsx)(c.code,{children:"500"})," | ",(0,s.jsx)(c.code,{children:"501"})," | ",(0,s.jsx)(c.code,{children:"502"})," | ",(0,s.jsx)(c.code,{children:"503"})," | ",(0,s.jsx)(c.code,{children:"504"})," | ",(0,s.jsx)(c.code,{children:"505"})," | ",(0,s.jsx)(c.code,{children:"506"})," | ",(0,s.jsx)(c.code,{children:"507"})," | ",(0,s.jsx)(c.code,{children:"508"})," | ",(0,s.jsx)(c.code,{children:"509"})," | ",(0,s.jsx)(c.code,{children:"590"})," | ",(0,s.jsx)(c.code,{children:"591"})," | ",(0,s.jsx)(c.code,{children:"592"})," | ",(0,s.jsx)(c.code,{children:"593"})," | ",(0,s.jsx)(c.code,{children:"594"})," | ",(0,s.jsx)(c.code,{children:"595"})," | ",(0,s.jsx)(c.code,{children:"596"})," | ",(0,s.jsx)(c.code,{children:"597"})," | ",(0,s.jsx)(c.code,{children:"598"})," | ",(0,s.jsx)(c.code,{children:"599"})," | ",(0,s.jsx)(c.code,{children:"670"})," | ",(0,s.jsx)(c.code,{children:"672"})," | ",(0,s.jsx)(c.code,{children:"673"})," | ",(0,s.jsx)(c.code,{children:"674"})," | ",(0,s.jsx)(c.code,{children:"675"})," | ",(0,s.jsx)(c.code,{children:"676"})," | ",(0,s.jsx)(c.code,{children:"677"})," | ",(0,s.jsx)(c.code,{children:"678"})," | ",(0,s.jsx)(c.code,{children:"679"})," | ",(0,s.jsx)(c.code,{children:"680"})," | ",(0,s.jsx)(c.code,{children:"681"})," | ",(0,s.jsx)(c.code,{children:"682"})," | ",(0,s.jsx)(c.code,{children:"683"})," | ",(0,s.jsx)(c.code,{children:"685"})," | ",(0,s.jsx)(c.code,{children:"686"})," | ",(0,s.jsx)(c.code,{children:"687"})," | ",(0,s.jsx)(c.code,{children:"688"})," | ",(0,s.jsx)(c.code,{children:"689"})," | ",(0,s.jsx)(c.code,{children:"690"})," | ",(0,s.jsx)(c.code,{children:"691"})," | ",(0,s.jsx)(c.code,{children:"692"})," | ",(0,s.jsx)(c.code,{children:"850"})," | ",(0,s.jsx)(c.code,{children:"852"})," | ",(0,s.jsx)(c.code,{children:"853"})," | ",(0,s.jsx)(c.code,{children:"855"})," | ",(0,s.jsx)(c.code,{children:"856"})," | ",(0,s.jsx)(c.code,{children:"880"})," | ",(0,s.jsx)(c.code,{children:"886"})," | ",(0,s.jsx)(c.code,{children:"960"})," | ",(0,s.jsx)(c.code,{children:"961"})," | ",(0,s.jsx)(c.code,{children:"962"})," | ",(0,s.jsx)(c.code,{children:"963"})," | ",(0,s.jsx)(c.code,{children:"964"})," | ",(0,s.jsx)(c.code,{children:"965"})," | ",(0,s.jsx)(c.code,{children:"966"})," | ",(0,s.jsx)(c.code,{children:"967"})," | ",(0,s.jsx)(c.code,{children:"968"})," | ",(0,s.jsx)(c.code,{children:"970"})," | ",(0,s.jsx)(c.code,{children:"971"})," | ",(0,s.jsx)(c.code,{children:"972"})," | ",(0,s.jsx)(c.code,{children:"973"})," | ",(0,s.jsx)(c.code,{children:"974"})," | ",(0,s.jsx)(c.code,{children:"975"})," | ",(0,s.jsx)(c.code,{children:"976"})," | ",(0,s.jsx)(c.code,{children:"977"})," | ",(0,s.jsx)(c.code,{children:"992"})," | ",(0,s.jsx)(c.code,{children:"993"})," | ",(0,s.jsx)(c.code,{children:"994"})," | ",(0,s.jsx)(c.code,{children:"995"})," | ",(0,s.jsx)(c.code,{children:"996"})," | ",(0,s.jsx)(c.code,{children:"998"})]}),"\n"]}),"\n",(0,s.jsx)(c.p,{children:"Type alias representing all available country codes"})]})}function j(e={}){const{wrapper:c}={...(0,n.R)(),...e.components};return c?(0,s.jsx)(c,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},8453:(e,c,d)=>{d.d(c,{R:()=>r,x:()=>i});var s=d(6540);const n={},o=s.createContext(n);function r(e){const c=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(c):{...c,...e}}),[c,e])}function i(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(o.Provider,{value:c},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/484e5a84.be42c8e7.js b/assets/js/484e5a84.be42c8e7.js new file mode 100644 index 0000000000..24de0a0fd6 --- /dev/null +++ b/assets/js/484e5a84.be42c8e7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6956],{9188:(e,c,d)=>{d.r(c),d.d(c,{assets:()=>l,contentTitle:()=>r,default:()=>j,frontMatter:()=>o,metadata:()=>i,toc:()=>h});var s=d(4848),n=d(8453);const o={},r="Type Alias: CountryCode",i={id:"reference/api/model/aliases/type-aliases/CountryCode",title:"Type Alias: CountryCode",description:"CountryCode: 1 \\| 7 \\| 20 \\| 27 \\| 30 \\| 31 \\| 32 \\| 33 \\| 34 \\| 36 \\| 39 \\| 40 \\| 41 \\| 43 \\| 44 \\| 45 \\| 46 \\| 47 \\| 48 \\| 49 \\| 51 \\| 52 \\| 53 \\| 54 \\| 55 \\| 56 \\| 57 \\| 58 \\| 60 \\| 61 \\| 62 \\| 63 \\| 64 \\| 65 \\| 66 \\| 81 \\| 82 \\| 84 \\| 86 \\| 90 \\| 91 \\| 92 \\| 93 \\| 94 \\| 95 \\| 98 \\| 211 \\| 212 \\| 213 \\| 216 \\| 218 \\| 220 \\| 221 \\| 222 \\| 223 \\| 224 \\| 225 \\| 226 \\| 227 \\| 228 \\| 229 \\| 230 \\| 231 \\| 232 \\| 233 \\| 234 \\| 235 \\| 236 \\| 237 \\| 238 \\| 239 \\| 240 \\| 241 \\| 242 \\| 243 \\| 244 \\| 245 \\| 246 \\| 248 \\| 249 \\| 250 \\| 251 \\| 252 \\| 253 \\| 254 \\| 255 \\| 256 \\| 257 \\| 258 \\| 260 \\| 261 \\| 262 \\| 263 \\| 264 \\| 265 \\| 266 \\| 267 \\| 268 \\| 269 \\| 290 \\| 291 \\| 297 \\| 298 \\| 299 \\| 350 \\| 351 \\| 352 \\| 353 \\| 354 \\| 355 \\| 356 \\| 357 \\| 358 \\| 359 \\| 370 \\| 371 \\| 372 \\| 373 \\| 374 \\| 375 \\| 376 \\| 377 \\| 378 \\| 380 \\| 381 \\| 382 \\| 383 \\| 385 \\| 386 \\| 387 \\| 389 \\| 420 \\| 421 \\| 423 \\| 500 \\| 501 \\| 502 \\| 503 \\| 504 \\| 505 \\| 506 \\| 507 \\| 508 \\| 509 \\| 590 \\| 591 \\| 592 \\| 593 \\| 594 \\| 595 \\| 596 \\| 597 \\| 598 \\| 599 \\| 670 \\| 672 \\| 673 \\| 674 \\| 675 \\| 676 \\| 677 \\| 678 \\| 679 \\| 680 \\| 681 \\| 682 \\| 683 \\| 685 \\| 686 \\| 687 \\| 688 \\| 689 \\| 690 \\| 691 \\| 692 \\| 850 \\| 852 \\| 853 \\| 855 \\| 856 \\| 880 \\| 886 \\| 960 \\| 961 \\| 962 \\| 963 \\| 964 \\| 965 \\| 966 \\| 967 \\| 968 \\| 970 \\| 971 \\| 972 \\| 973 \\| 974 \\| 975 \\| 976 \\| 977 \\| 992 \\| 993 \\| 994 \\| 995 \\| 996 \\| 998",source:"@site/docs/reference/api/model/aliases/type-aliases/CountryCode.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/CountryCode",permalink:"/docs/reference/api/model/aliases/type-aliases/CountryCode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/CountryCode.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Content",permalink:"/docs/reference/api/model/aliases/type-aliases/Content"},next:{title:"Type Alias: DataURL",permalink:"/docs/reference/api/model/aliases/type-aliases/DataURL"}},l={},h=[];function x(e){const c={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(c.header,{children:(0,s.jsx)(c.h1,{id:"type-alias-countrycode",children:"Type Alias: CountryCode"})}),"\n",(0,s.jsxs)(c.blockquote,{children:["\n",(0,s.jsxs)(c.p,{children:[(0,s.jsx)(c.strong,{children:"CountryCode"}),": ",(0,s.jsx)(c.code,{children:"1"})," | ",(0,s.jsx)(c.code,{children:"7"})," | ",(0,s.jsx)(c.code,{children:"20"})," | ",(0,s.jsx)(c.code,{children:"27"})," | ",(0,s.jsx)(c.code,{children:"30"})," | ",(0,s.jsx)(c.code,{children:"31"})," | ",(0,s.jsx)(c.code,{children:"32"})," | ",(0,s.jsx)(c.code,{children:"33"})," | ",(0,s.jsx)(c.code,{children:"34"})," | ",(0,s.jsx)(c.code,{children:"36"})," | ",(0,s.jsx)(c.code,{children:"39"})," | ",(0,s.jsx)(c.code,{children:"40"})," | ",(0,s.jsx)(c.code,{children:"41"})," | ",(0,s.jsx)(c.code,{children:"43"})," | ",(0,s.jsx)(c.code,{children:"44"})," | ",(0,s.jsx)(c.code,{children:"45"})," | ",(0,s.jsx)(c.code,{children:"46"})," | ",(0,s.jsx)(c.code,{children:"47"})," | ",(0,s.jsx)(c.code,{children:"48"})," | ",(0,s.jsx)(c.code,{children:"49"})," | ",(0,s.jsx)(c.code,{children:"51"})," | ",(0,s.jsx)(c.code,{children:"52"})," | ",(0,s.jsx)(c.code,{children:"53"})," | ",(0,s.jsx)(c.code,{children:"54"})," | ",(0,s.jsx)(c.code,{children:"55"})," | ",(0,s.jsx)(c.code,{children:"56"})," | ",(0,s.jsx)(c.code,{children:"57"})," | ",(0,s.jsx)(c.code,{children:"58"})," | ",(0,s.jsx)(c.code,{children:"60"})," | ",(0,s.jsx)(c.code,{children:"61"})," | ",(0,s.jsx)(c.code,{children:"62"})," | ",(0,s.jsx)(c.code,{children:"63"})," | ",(0,s.jsx)(c.code,{children:"64"})," | ",(0,s.jsx)(c.code,{children:"65"})," | ",(0,s.jsx)(c.code,{children:"66"})," | ",(0,s.jsx)(c.code,{children:"81"})," | ",(0,s.jsx)(c.code,{children:"82"})," | ",(0,s.jsx)(c.code,{children:"84"})," | ",(0,s.jsx)(c.code,{children:"86"})," | ",(0,s.jsx)(c.code,{children:"90"})," | ",(0,s.jsx)(c.code,{children:"91"})," | ",(0,s.jsx)(c.code,{children:"92"})," | ",(0,s.jsx)(c.code,{children:"93"})," | ",(0,s.jsx)(c.code,{children:"94"})," | ",(0,s.jsx)(c.code,{children:"95"})," | ",(0,s.jsx)(c.code,{children:"98"})," | ",(0,s.jsx)(c.code,{children:"211"})," | ",(0,s.jsx)(c.code,{children:"212"})," | ",(0,s.jsx)(c.code,{children:"213"})," | ",(0,s.jsx)(c.code,{children:"216"})," | ",(0,s.jsx)(c.code,{children:"218"})," | ",(0,s.jsx)(c.code,{children:"220"})," | ",(0,s.jsx)(c.code,{children:"221"})," | ",(0,s.jsx)(c.code,{children:"222"})," | ",(0,s.jsx)(c.code,{children:"223"})," | ",(0,s.jsx)(c.code,{children:"224"})," | ",(0,s.jsx)(c.code,{children:"225"})," | ",(0,s.jsx)(c.code,{children:"226"})," | ",(0,s.jsx)(c.code,{children:"227"})," | ",(0,s.jsx)(c.code,{children:"228"})," | ",(0,s.jsx)(c.code,{children:"229"})," | ",(0,s.jsx)(c.code,{children:"230"})," | ",(0,s.jsx)(c.code,{children:"231"})," | ",(0,s.jsx)(c.code,{children:"232"})," | ",(0,s.jsx)(c.code,{children:"233"})," | ",(0,s.jsx)(c.code,{children:"234"})," | ",(0,s.jsx)(c.code,{children:"235"})," | ",(0,s.jsx)(c.code,{children:"236"})," | ",(0,s.jsx)(c.code,{children:"237"})," | ",(0,s.jsx)(c.code,{children:"238"})," | ",(0,s.jsx)(c.code,{children:"239"})," | ",(0,s.jsx)(c.code,{children:"240"})," | ",(0,s.jsx)(c.code,{children:"241"})," | ",(0,s.jsx)(c.code,{children:"242"})," | ",(0,s.jsx)(c.code,{children:"243"})," | ",(0,s.jsx)(c.code,{children:"244"})," | ",(0,s.jsx)(c.code,{children:"245"})," | ",(0,s.jsx)(c.code,{children:"246"})," | ",(0,s.jsx)(c.code,{children:"248"})," | ",(0,s.jsx)(c.code,{children:"249"})," | ",(0,s.jsx)(c.code,{children:"250"})," | ",(0,s.jsx)(c.code,{children:"251"})," | ",(0,s.jsx)(c.code,{children:"252"})," | ",(0,s.jsx)(c.code,{children:"253"})," | ",(0,s.jsx)(c.code,{children:"254"})," | ",(0,s.jsx)(c.code,{children:"255"})," | ",(0,s.jsx)(c.code,{children:"256"})," | ",(0,s.jsx)(c.code,{children:"257"})," | ",(0,s.jsx)(c.code,{children:"258"})," | ",(0,s.jsx)(c.code,{children:"260"})," | ",(0,s.jsx)(c.code,{children:"261"})," | ",(0,s.jsx)(c.code,{children:"262"})," | ",(0,s.jsx)(c.code,{children:"263"})," | ",(0,s.jsx)(c.code,{children:"264"})," | ",(0,s.jsx)(c.code,{children:"265"})," | ",(0,s.jsx)(c.code,{children:"266"})," | ",(0,s.jsx)(c.code,{children:"267"})," | ",(0,s.jsx)(c.code,{children:"268"})," | ",(0,s.jsx)(c.code,{children:"269"})," | ",(0,s.jsx)(c.code,{children:"290"})," | ",(0,s.jsx)(c.code,{children:"291"})," | ",(0,s.jsx)(c.code,{children:"297"})," | ",(0,s.jsx)(c.code,{children:"298"})," | ",(0,s.jsx)(c.code,{children:"299"})," | ",(0,s.jsx)(c.code,{children:"350"})," | ",(0,s.jsx)(c.code,{children:"351"})," | ",(0,s.jsx)(c.code,{children:"352"})," | ",(0,s.jsx)(c.code,{children:"353"})," | ",(0,s.jsx)(c.code,{children:"354"})," | ",(0,s.jsx)(c.code,{children:"355"})," | ",(0,s.jsx)(c.code,{children:"356"})," | ",(0,s.jsx)(c.code,{children:"357"})," | ",(0,s.jsx)(c.code,{children:"358"})," | ",(0,s.jsx)(c.code,{children:"359"})," | ",(0,s.jsx)(c.code,{children:"370"})," | ",(0,s.jsx)(c.code,{children:"371"})," | ",(0,s.jsx)(c.code,{children:"372"})," | ",(0,s.jsx)(c.code,{children:"373"})," | ",(0,s.jsx)(c.code,{children:"374"})," | ",(0,s.jsx)(c.code,{children:"375"})," | ",(0,s.jsx)(c.code,{children:"376"})," | ",(0,s.jsx)(c.code,{children:"377"})," | ",(0,s.jsx)(c.code,{children:"378"})," | ",(0,s.jsx)(c.code,{children:"380"})," | ",(0,s.jsx)(c.code,{children:"381"})," | ",(0,s.jsx)(c.code,{children:"382"})," | ",(0,s.jsx)(c.code,{children:"383"})," | ",(0,s.jsx)(c.code,{children:"385"})," | ",(0,s.jsx)(c.code,{children:"386"})," | ",(0,s.jsx)(c.code,{children:"387"})," | ",(0,s.jsx)(c.code,{children:"389"})," | ",(0,s.jsx)(c.code,{children:"420"})," | ",(0,s.jsx)(c.code,{children:"421"})," | ",(0,s.jsx)(c.code,{children:"423"})," | ",(0,s.jsx)(c.code,{children:"500"})," | ",(0,s.jsx)(c.code,{children:"501"})," | ",(0,s.jsx)(c.code,{children:"502"})," | ",(0,s.jsx)(c.code,{children:"503"})," | ",(0,s.jsx)(c.code,{children:"504"})," | ",(0,s.jsx)(c.code,{children:"505"})," | ",(0,s.jsx)(c.code,{children:"506"})," | ",(0,s.jsx)(c.code,{children:"507"})," | ",(0,s.jsx)(c.code,{children:"508"})," | ",(0,s.jsx)(c.code,{children:"509"})," | ",(0,s.jsx)(c.code,{children:"590"})," | ",(0,s.jsx)(c.code,{children:"591"})," | ",(0,s.jsx)(c.code,{children:"592"})," | ",(0,s.jsx)(c.code,{children:"593"})," | ",(0,s.jsx)(c.code,{children:"594"})," | ",(0,s.jsx)(c.code,{children:"595"})," | ",(0,s.jsx)(c.code,{children:"596"})," | ",(0,s.jsx)(c.code,{children:"597"})," | ",(0,s.jsx)(c.code,{children:"598"})," | ",(0,s.jsx)(c.code,{children:"599"})," | ",(0,s.jsx)(c.code,{children:"670"})," | ",(0,s.jsx)(c.code,{children:"672"})," | ",(0,s.jsx)(c.code,{children:"673"})," | ",(0,s.jsx)(c.code,{children:"674"})," | ",(0,s.jsx)(c.code,{children:"675"})," | ",(0,s.jsx)(c.code,{children:"676"})," | ",(0,s.jsx)(c.code,{children:"677"})," | ",(0,s.jsx)(c.code,{children:"678"})," | ",(0,s.jsx)(c.code,{children:"679"})," | ",(0,s.jsx)(c.code,{children:"680"})," | ",(0,s.jsx)(c.code,{children:"681"})," | ",(0,s.jsx)(c.code,{children:"682"})," | ",(0,s.jsx)(c.code,{children:"683"})," | ",(0,s.jsx)(c.code,{children:"685"})," | ",(0,s.jsx)(c.code,{children:"686"})," | ",(0,s.jsx)(c.code,{children:"687"})," | ",(0,s.jsx)(c.code,{children:"688"})," | ",(0,s.jsx)(c.code,{children:"689"})," | ",(0,s.jsx)(c.code,{children:"690"})," | ",(0,s.jsx)(c.code,{children:"691"})," | ",(0,s.jsx)(c.code,{children:"692"})," | ",(0,s.jsx)(c.code,{children:"850"})," | ",(0,s.jsx)(c.code,{children:"852"})," | ",(0,s.jsx)(c.code,{children:"853"})," | ",(0,s.jsx)(c.code,{children:"855"})," | ",(0,s.jsx)(c.code,{children:"856"})," | ",(0,s.jsx)(c.code,{children:"880"})," | ",(0,s.jsx)(c.code,{children:"886"})," | ",(0,s.jsx)(c.code,{children:"960"})," | ",(0,s.jsx)(c.code,{children:"961"})," | ",(0,s.jsx)(c.code,{children:"962"})," | ",(0,s.jsx)(c.code,{children:"963"})," | ",(0,s.jsx)(c.code,{children:"964"})," | ",(0,s.jsx)(c.code,{children:"965"})," | ",(0,s.jsx)(c.code,{children:"966"})," | ",(0,s.jsx)(c.code,{children:"967"})," | ",(0,s.jsx)(c.code,{children:"968"})," | ",(0,s.jsx)(c.code,{children:"970"})," | ",(0,s.jsx)(c.code,{children:"971"})," | ",(0,s.jsx)(c.code,{children:"972"})," | ",(0,s.jsx)(c.code,{children:"973"})," | ",(0,s.jsx)(c.code,{children:"974"})," | ",(0,s.jsx)(c.code,{children:"975"})," | ",(0,s.jsx)(c.code,{children:"976"})," | ",(0,s.jsx)(c.code,{children:"977"})," | ",(0,s.jsx)(c.code,{children:"992"})," | ",(0,s.jsx)(c.code,{children:"993"})," | ",(0,s.jsx)(c.code,{children:"994"})," | ",(0,s.jsx)(c.code,{children:"995"})," | ",(0,s.jsx)(c.code,{children:"996"})," | ",(0,s.jsx)(c.code,{children:"998"})]}),"\n"]}),"\n",(0,s.jsx)(c.p,{children:"Type alias representing all available country codes"})]})}function j(e={}){const{wrapper:c}={...(0,n.R)(),...e.components};return c?(0,s.jsx)(c,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},8453:(e,c,d)=>{d.d(c,{R:()=>r,x:()=>i});var s=d(6540);const n={},o=s.createContext(n);function r(e){const c=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(c):{...c,...e}}),[c,e])}function i(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(o.Provider,{value:c},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b6dedc4.000521a0.js b/assets/js/4b6dedc4.000521a0.js deleted file mode 100644 index e8cbcd7fac..0000000000 --- a/assets/js/4b6dedc4.000521a0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[493],{6909:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var o=n(4848),r=n(8453);const c={},i="Interface: LocationButtonBody",s={id:"reference/api/model/button/interfaces/LocationButtonBody",title:"Interface: LocationButtonBody",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/LocationButtonBody.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/LocationButtonBody.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Button",permalink:"/docs/reference/api/model/button/interfaces/Button"},next:{title:"Interface: Row",permalink:"/docs/reference/api/model/button/interfaces/Row"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"caption",id:"caption",level:3},{value:"lat",id:"lat",level:3},{value:"lng",id:"lng",level:3}];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"interface-locationbuttonbody",children:"Interface: LocationButtonBody"}),"\n",(0,o.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(t.h3,{id:"caption",children:"caption"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"caption"}),": ",(0,o.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h3,{id:"lat",children:"lat"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"lat"}),": ",(0,o.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h3,{id:"lng",children:"lng"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"lng"}),": ",(0,o.jsx)(t.code,{children:"number"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>s});var o=n(6540);const r={},c=o.createContext(r);function i(e){const t=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b6dedc4.4712b340.js b/assets/js/4b6dedc4.4712b340.js new file mode 100644 index 0000000000..1b8905edcf --- /dev/null +++ b/assets/js/4b6dedc4.4712b340.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[493],{6909:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var o=n(4848),r=n(8453);const c={},i="Interface: LocationButtonBody",s={id:"reference/api/model/button/interfaces/LocationButtonBody",title:"Interface: LocationButtonBody",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/LocationButtonBody.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/LocationButtonBody.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Button",permalink:"/docs/reference/api/model/button/interfaces/Button"},next:{title:"Interface: Row",permalink:"/docs/reference/api/model/button/interfaces/Row"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"caption",id:"caption",level:3},{value:"lat",id:"lat",level:3},{value:"lng",id:"lng",level:3}];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"interface-locationbuttonbody",children:"Interface: LocationButtonBody"})}),"\n",(0,o.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(t.h3,{id:"caption",children:"caption"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"caption"}),": ",(0,o.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h3,{id:"lat",children:"lat"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"lat"}),": ",(0,o.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h3,{id:"lng",children:"lng"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"lng"}),": ",(0,o.jsx)(t.code,{children:"number"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>s});var o=n(6540);const r={},c=o.createContext(r);function i(e){const t=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4bc6cdf6.4bf46d7f.js b/assets/js/4bc6cdf6.4bf46d7f.js deleted file mode 100644 index 683a8fcada..0000000000 --- a/assets/js/4bc6cdf6.4bf46d7f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9223],{3337:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=r(4848),n=r(8453);const c={},o="Type Alias: CheckFunction()",a={id:"reference/structures/Dialog/type-aliases/CheckFunction",title:"Type Alias: CheckFunction()",description:"CheckFunction: (lastReceivedMessage, currentProps) => boolean",source:"@site/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",sourceDirName:"reference/structures/Dialog/type-aliases",slug:"/reference/structures/Dialog/type-aliases/CheckFunction",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation"},next:{title:"structures/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"type-alias-checkfunction",children:"Type Alias: CheckFunction()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"CheckFunction"}),": (",(0,t.jsx)(s.code,{children:"lastReceivedMessage"}),", ",(0,t.jsx)(s.code,{children:"currentProps"}),") => ",(0,t.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"lastReceivedMessage"}),": ",(0,t.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,t.jsx)(s.code,{children:"Message"})})]}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"currentProps"}),": ",(0,t.jsx)(s.a,{href:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",children:(0,t.jsx)(s.code,{children:"CurrentDialogProps"})})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"boolean"})})]})}function d(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>o,x:()=>a});var t=r(6540);const n={},c=t.createContext(n);function o(e){const s=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),t.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4bc6cdf6.ba06eb86.js b/assets/js/4bc6cdf6.ba06eb86.js new file mode 100644 index 0000000000..9cd03e591d --- /dev/null +++ b/assets/js/4bc6cdf6.ba06eb86.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9223],{3337:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=s(4848),n=s(8453);const c={},o="Type Alias: CheckFunction()",a={id:"reference/structures/Dialog/type-aliases/CheckFunction",title:"Type Alias: CheckFunction()",description:"CheckFunction: (lastReceivedMessage, currentProps) => boolean",source:"@site/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",sourceDirName:"reference/structures/Dialog/type-aliases",slug:"/reference/structures/Dialog/type-aliases/CheckFunction",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation"},next:{title:"structures/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function u(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"type-alias-checkfunction",children:"Type Alias: CheckFunction()"})}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"CheckFunction"}),": (",(0,t.jsx)(r.code,{children:"lastReceivedMessage"}),", ",(0,t.jsx)(r.code,{children:"currentProps"}),") => ",(0,t.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"lastReceivedMessage"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,t.jsx)(r.code,{children:"Message"})})]}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"currentProps"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",children:(0,t.jsx)(r.code,{children:"CurrentDialogProps"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"boolean"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>a});var t=s(6540);const n={},c=t.createContext(n);function o(e){const r=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),t.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52c02df4.07d134c8.js b/assets/js/52c02df4.07d134c8.js deleted file mode 100644 index de5a5f6fb0..0000000000 --- a/assets/js/52c02df4.07d134c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8283],{1802:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>f,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=n(4848),r=n(8453);const o={},a="Interface: MessageInfoInteraction",c={id:"reference/api/model/message/interfaces/MessageInfoInteraction",title:"Interface: MessageInfoInteraction",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo"},next:{title:"Interface: PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"t",id:"t",level:3}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-messageinfointeraction",children:"Interface: MessageInfoInteraction"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"id"}),": ",(0,s.jsx)(t.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,s.jsx)(t.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The contact ID of the contact that interacted with the message."}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"t",children:"t"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"t"}),": ",(0,s.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The timestamp of the interaction. You have to x 1000 to use in a JS Date object."})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var s=n(6540);const r={},o=s.createContext(r);function a(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52c02df4.fa1f6eb9.js b/assets/js/52c02df4.fa1f6eb9.js new file mode 100644 index 0000000000..33ae1c00ce --- /dev/null +++ b/assets/js/52c02df4.fa1f6eb9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8283],{1802:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>f,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(4848),r=t(8453);const o={},a="Interface: MessageInfoInteraction",c={id:"reference/api/model/message/interfaces/MessageInfoInteraction",title:"Interface: MessageInfoInteraction",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo"},next:{title:"Interface: PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"t",id:"t",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-messageinfointeraction",children:"Interface: MessageInfoInteraction"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,s.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The contact ID of the contact that interacted with the message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"t"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The timestamp of the interaction. You have to x 1000 to use in a JS Date object."})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(6540);const r={},o=s.createContext(r);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52eba09e.125dd15b.js b/assets/js/52eba09e.125dd15b.js deleted file mode 100644 index ff18149895..0000000000 --- a/assets/js/52eba09e.125dd15b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2254],{4515:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>o,frontMatter:()=>s,metadata:()=>h,toc:()=>t});var i=r(4848),d=r(8453);const s={},c="Interface: GroupChat",h={id:"reference/api/model/chat/interfaces/GroupChat",title:"Interface: GroupChat",description:"Extends",source:"@site/docs/reference/api/model/chat/interfaces/GroupChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat"},next:{title:"Interface: GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse"}},a={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"archive",id:"archive",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"canSend?",id:"cansend",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"contact",id:"contact",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"id",id:"id",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"isGroup",id:"isgroup",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"kind",id:"kind",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"labels",id:"labels",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"msgs",id:"msgs",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"notSpam",id:"notspam",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"pic?",id:"pic",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"pin",id:"pin",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"presence",id:"presence",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"t",id:"t",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"unreadCount",id:"unreadcount",level:3},{value:"Inherited from",id:"inherited-from-25",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-groupchat",children:"Interface: GroupChat"}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#ack",children:(0,i.jsx)(n.code,{children:"ack"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#archive",children:(0,i.jsx)(n.code,{children:"archive"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#cansend",children:(0,i.jsx)(n.code,{children:"canSend"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumbernewjid",children:(0,i.jsx)(n.code,{children:"changeNumberNewJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumberoldjid",children:(0,i.jsx)(n.code,{children:"changeNumberOldJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#contact",children:(0,i.jsx)(n.code,{children:"contact"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#formattedtitle",children:(0,i.jsx)(n.code,{children:"formattedTitle"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#groupmetadata",children:(0,i.jsx)(n.code,{children:"groupMetadata"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(n.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isannouncegrprestrict",children:(0,i.jsx)(n.code,{children:"isAnnounceGrpRestrict"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isGroup"}),": ",(0,i.jsx)(n.code,{children:"true"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isonline",children:(0,i.jsx)(n.code,{children:"isOnline"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isreadonly",children:(0,i.jsx)(n.code,{children:"isReadOnly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#kind",children:(0,i.jsx)(n.code,{children:"kind"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#labels",children:(0,i.jsx)(n.code,{children:"labels"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastreceivedkey",children:(0,i.jsx)(n.code,{children:"lastReceivedKey"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastseen",children:(0,i.jsx)(n.code,{children:"lastSeen"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#modifytag",children:(0,i.jsx)(n.code,{children:"modifyTag"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#msgs",children:(0,i.jsx)(n.code,{children:"msgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#muteexpiration",children:(0,i.jsx)(n.code,{children:"muteExpiration"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#name",children:(0,i.jsx)(n.code,{children:"name"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#notspam",children:(0,i.jsx)(n.code,{children:"notSpam"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pendingmsgs",children:(0,i.jsx)(n.code,{children:"pendingMsgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pic",children:(0,i.jsx)(n.code,{children:"pic"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pin",children:(0,i.jsx)(n.code,{children:"pin"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#presence",children:(0,i.jsx)(n.code,{children:"presence"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#t",children:(0,i.jsx)(n.code,{children:"t"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#unreadcount",children:(0,i.jsx)(n.code,{children:"unreadCount"})})]})]})}function o(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>h});var i=r(6540);const d={},s=i.createContext(d);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function h(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52eba09e.4c178fd9.js b/assets/js/52eba09e.4c178fd9.js new file mode 100644 index 0000000000..a84e4947f5 --- /dev/null +++ b/assets/js/52eba09e.4c178fd9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2254],{4515:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>o,frontMatter:()=>s,metadata:()=>h,toc:()=>t});var i=r(4848),d=r(8453);const s={},c="Interface: GroupChat",h={id:"reference/api/model/chat/interfaces/GroupChat",title:"Interface: GroupChat",description:"Extends",source:"@site/docs/reference/api/model/chat/interfaces/GroupChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat"},next:{title:"Interface: GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse"}},a={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"archive",id:"archive",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"canSend?",id:"cansend",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"contact",id:"contact",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"id",id:"id",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"isGroup",id:"isgroup",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"kind",id:"kind",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"labels",id:"labels",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"msgs",id:"msgs",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"notSpam",id:"notspam",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"pic?",id:"pic",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"pin",id:"pin",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"presence",id:"presence",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"t",id:"t",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"unreadCount",id:"unreadcount",level:3},{value:"Inherited from",id:"inherited-from-25",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-groupchat",children:"Interface: GroupChat"})}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#ack",children:(0,i.jsx)(n.code,{children:"ack"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#archive",children:(0,i.jsx)(n.code,{children:"archive"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#cansend",children:(0,i.jsx)(n.code,{children:"canSend"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumbernewjid",children:(0,i.jsx)(n.code,{children:"changeNumberNewJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#changenumberoldjid",children:(0,i.jsx)(n.code,{children:"changeNumberOldJid"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#contact",children:(0,i.jsx)(n.code,{children:"contact"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#formattedtitle",children:(0,i.jsx)(n.code,{children:"formattedTitle"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#groupmetadata",children:(0,i.jsx)(n.code,{children:"groupMetadata"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(n.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isannouncegrprestrict",children:(0,i.jsx)(n.code,{children:"isAnnounceGrpRestrict"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isGroup"}),": ",(0,i.jsx)(n.code,{children:"true"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isonline",children:(0,i.jsx)(n.code,{children:"isOnline"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#isreadonly",children:(0,i.jsx)(n.code,{children:"isReadOnly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#kind",children:(0,i.jsx)(n.code,{children:"kind"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#labels",children:(0,i.jsx)(n.code,{children:"labels"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastreceivedkey",children:(0,i.jsx)(n.code,{children:"lastReceivedKey"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#lastseen",children:(0,i.jsx)(n.code,{children:"lastSeen"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#modifytag",children:(0,i.jsx)(n.code,{children:"modifyTag"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#msgs",children:(0,i.jsx)(n.code,{children:"msgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#muteexpiration",children:(0,i.jsx)(n.code,{children:"muteExpiration"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#name",children:(0,i.jsx)(n.code,{children:"name"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#notspam",children:(0,i.jsx)(n.code,{children:"notSpam"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pendingmsgs",children:(0,i.jsx)(n.code,{children:"pendingMsgs"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pic",children:(0,i.jsx)(n.code,{children:"pic"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#pin",children:(0,i.jsx)(n.code,{children:"pin"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#presence",children:(0,i.jsx)(n.code,{children:"presence"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#t",children:(0,i.jsx)(n.code,{children:"t"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:(0,i.jsx)(n.code,{children:"BaseChat"})}),".",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat#unreadcount",children:(0,i.jsx)(n.code,{children:"unreadCount"})})]})]})}function o(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>h});var i=r(6540);const d={},s=i.createContext(d);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function h(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/533a09ca.49d34c80.js b/assets/js/533a09ca.49d34c80.js new file mode 100644 index 0000000000..a253d9b4e1 --- /dev/null +++ b/assets/js/533a09ca.49d34c80.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3098],{4700:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var o=s(4848),r=s(8453);const a={sidebar_position:3},n="Create a Blog Post",i={id:"tutorial-basics/create-a-blog-post",title:"Create a Blog Post",description:"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...",source:"@site/docs/tutorial-basics/create-a-blog-post.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-blog-post",permalink:"/docs/tutorial-basics/create-a-blog-post",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-blog-post.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Create a Document",permalink:"/docs/tutorial-basics/create-a-document"},next:{title:"Markdown Features",permalink:"/docs/tutorial-basics/markdown-features"}},c={},l=[{value:"Create your first Post",id:"create-your-first-post",level:2}];function u(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"create-a-blog-post",children:"Create a Blog Post"})}),"\n",(0,o.jsxs)(t.p,{children:["Docusaurus creates a ",(0,o.jsx)(t.strong,{children:"page for each blog post"}),", but also a ",(0,o.jsx)(t.strong,{children:"blog index page"}),", a ",(0,o.jsx)(t.strong,{children:"tag system"}),", an ",(0,o.jsx)(t.strong,{children:"RSS"})," feed..."]}),"\n",(0,o.jsx)(t.h2,{id:"create-your-first-post",children:"Create your first Post"}),"\n",(0,o.jsxs)(t.p,{children:["Create a file at ",(0,o.jsx)(t.code,{children:"blog/2021-02-28-greetings.md"}),":"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-md",metastring:'title="blog/2021-02-28-greetings.md"',children:"---\nslug: greetings\ntitle: Greetings!\nauthors:\n - name: Joel Marcey\n title: Co-creator of Docusaurus 1\n url: https://github.com/JoelMarcey\n image_url: https://github.com/JoelMarcey.png\n - name: S\xe9bastien Lorber\n title: Docusaurus maintainer\n url: https://sebastienlorber.com\n image_url: https://github.com/slorber.png\ntags: [greetings]\n---\n\nCongratulations, you have made your first post!\n\nFeel free to play around and edit this post as much as you like.\n"})}),"\n",(0,o.jsxs)(t.p,{children:["A new blog post is now available at ",(0,o.jsx)(t.a,{href:"http://localhost:3000/blog/greetings",children:"http://localhost:3000/blog/greetings"}),"."]})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>n,x:()=>i});var o=s(6540);const r={},a=o.createContext(r);function n(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/533a09ca.7c8e161d.js b/assets/js/533a09ca.7c8e161d.js deleted file mode 100644 index b42faf3a5a..0000000000 --- a/assets/js/533a09ca.7c8e161d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3098],{4700:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=s(4848),a=s(8453);const r={sidebar_position:3},n="Create a Blog Post",i={id:"tutorial-basics/create-a-blog-post",title:"Create a Blog Post",description:"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...",source:"@site/docs/tutorial-basics/create-a-blog-post.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-blog-post",permalink:"/docs/tutorial-basics/create-a-blog-post",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-blog-post.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Create a Document",permalink:"/docs/tutorial-basics/create-a-document"},next:{title:"Markdown Features",permalink:"/docs/tutorial-basics/markdown-features"}},c={},l=[{value:"Create your first Post",id:"create-your-first-post",level:2}];function u(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"create-a-blog-post",children:"Create a Blog Post"}),"\n",(0,o.jsxs)(t.p,{children:["Docusaurus creates a ",(0,o.jsx)(t.strong,{children:"page for each blog post"}),", but also a ",(0,o.jsx)(t.strong,{children:"blog index page"}),", a ",(0,o.jsx)(t.strong,{children:"tag system"}),", an ",(0,o.jsx)(t.strong,{children:"RSS"})," feed..."]}),"\n",(0,o.jsx)(t.h2,{id:"create-your-first-post",children:"Create your first Post"}),"\n",(0,o.jsxs)(t.p,{children:["Create a file at ",(0,o.jsx)(t.code,{children:"blog/2021-02-28-greetings.md"}),":"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-md",metastring:'title="blog/2021-02-28-greetings.md"',children:"---\nslug: greetings\ntitle: Greetings!\nauthors:\n - name: Joel Marcey\n title: Co-creator of Docusaurus 1\n url: https://github.com/JoelMarcey\n image_url: https://github.com/JoelMarcey.png\n - name: S\xe9bastien Lorber\n title: Docusaurus maintainer\n url: https://sebastienlorber.com\n image_url: https://github.com/slorber.png\ntags: [greetings]\n---\n\nCongratulations, you have made your first post!\n\nFeel free to play around and edit this post as much as you like.\n"})}),"\n",(0,o.jsxs)(t.p,{children:["A new blog post is now available at ",(0,o.jsx)(t.a,{href:"http://localhost:3000/blog/greetings",children:"http://localhost:3000/blog/greetings"}),"."]})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>n,x:()=>i});var o=s(6540);const a={},r=o.createContext(a);function n(e){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),o.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5471f4ea.507f3066.js b/assets/js/5471f4ea.507f3066.js new file mode 100644 index 0000000000..9f42264eb8 --- /dev/null +++ b/assets/js/5471f4ea.507f3066.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6724],{6631:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>h});var s=n(4848),o=n(8453);const i={sidebar_label:"The Client",description:"Guide showing how to edit the settings.",sidebar_position:1},a="The Client",r={id:"configuration/the-client",title:"The Client",description:"Guide showing how to edit the settings.",source:"@site/docs/configuration/the-client.md",sourceDirName:"configuration",slug:"/configuration/the-client",permalink:"/docs/configuration/the-client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/the-client.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_label:"The Client",description:"Guide showing how to edit the settings.",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"EASY API CLI options",permalink:"/docs/configuration/command-line-options"},next:{title:"Capturing QR Code",permalink:"/docs/configuration/capture-qr"}},c={},h=[{value:"How to create a client",id:"how-to-create-a-client",level:2},{value:"What happens when the session starts",id:"what-happens-when-the-session-starts",level:2}];function l(e){const t={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"the-client",children:"The Client"})}),"\n",(0,s.jsx)(t.p,{children:"Who/what is the client? The Client is the orchestrator of a WA Web session. You can have multiple clients in one node (or ts-node) process. But it's generally best practice to keep a single client on a single process."}),"\n",(0,s.jsx)(t.h2,{id:"how-to-create-a-client",children:"How to create a client"}),"\n",(0,s.jsxs)(t.p,{children:["After you've installed the library in your project, you can then use [create] to ",(0,s.jsx)(t.em,{children:(0,s.jsx)(t.strong,{children:"create"})})," a new session. This simple example starts a bot that replies with ",(0,s.jsx)(t.code,{children:"\ud83d\udc4b Hello!"})," when it receives a ",(0,s.jsx)(t.code,{children:"Hi"})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"const { create, Client } = require('@open-wa/wa-automate');\n\n// or\n// import { create, Client } from '@open-wa/wa-automate';\n\n\nfunction start(client) {\n client.onMessage(async message => {\n if (message.body === 'Hi') {\n await client.sendText(message.from, '\ud83d\udc4b Hello!');\n }\n });\n}\n\ncreate().then(start);\n\n"})}),"\n",(0,s.jsxs)(t.p,{children:["The method ",(0,s.jsx)(t.code,{children:"create"})," is what creates, authenticates/reloads a session. When you call create, make sure to keep an eye on the console output. In the console it will log the loading state of the client and the QR code (if there is no valid session data)."]}),"\n",(0,s.jsxs)(t.p,{children:["You can call ",(0,s.jsx)(t.code,{children:"create()"})," on it's own, however there are a bunch of powerful configuration variables you can set to acheive a more custom set up."]}),"\n",(0,s.jsx)(t.p,{children:"[[ConfigObject]]"}),"\n",(0,s.jsx)(t.p,{children:"Please note that you will be unable to scan the QR code if it is on a dark background."}),"\n",(0,s.jsx)(t.h2,{id:"what-happens-when-the-session-starts",children:"What happens when the session starts"}),"\n",(0,s.jsx)(t.p,{children:"In order to eliminate potential phishing attacks using this library, a message is sent to the host account from itself notifying the account user that the account is being managed/controlled using an automation software."}),"\n",(0,s.jsx)(t.p,{children:"This host notification will result in a CORS error in the browser instance. You can ignore the error."}),"\n",(0,s.jsxs)(t.p,{children:["Learn more here: ",(0,s.jsx)(t.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088",children:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088"})]})]})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var s=n(6540);const o={},i=s.createContext(o);function a(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5471f4ea.e94b9bff.js b/assets/js/5471f4ea.e94b9bff.js deleted file mode 100644 index aab00af8c8..0000000000 --- a/assets/js/5471f4ea.e94b9bff.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6724],{6631:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>h});var s=n(4848),o=n(8453);const i={sidebar_label:"The Client",description:"Guide showing how to edit the settings.",sidebar_position:1},a="The Client",r={id:"configuration/the-client",title:"The Client",description:"Guide showing how to edit the settings.",source:"@site/docs/configuration/the-client.md",sourceDirName:"configuration",slug:"/configuration/the-client",permalink:"/docs/configuration/the-client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/the-client.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_label:"The Client",description:"Guide showing how to edit the settings.",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"EASY API CLI options",permalink:"/docs/configuration/command-line-options"},next:{title:"Capturing QR Code",permalink:"/docs/configuration/capture-qr"}},c={},h=[{value:"How to create a client",id:"how-to-create-a-client",level:2},{value:"What happens when the session starts",id:"what-happens-when-the-session-starts",level:2}];function l(e){const t={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"the-client",children:"The Client"}),"\n",(0,s.jsx)(t.p,{children:"Who/what is the client? The Client is the orchestrator of a WA Web session. You can have multiple clients in one node (or ts-node) process. But it's generally best practice to keep a single client on a single process."}),"\n",(0,s.jsx)(t.h2,{id:"how-to-create-a-client",children:"How to create a client"}),"\n",(0,s.jsxs)(t.p,{children:["After you've installed the library in your project, you can then use [create] to ",(0,s.jsx)(t.em,{children:(0,s.jsx)(t.strong,{children:"create"})})," a new session. This simple example starts a bot that replies with ",(0,s.jsx)(t.code,{children:"\ud83d\udc4b Hello!"})," when it receives a ",(0,s.jsx)(t.code,{children:"Hi"})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"const { create, Client } = require('@open-wa/wa-automate');\n\n// or\n// import { create, Client } from '@open-wa/wa-automate';\n\n\nfunction start(client) {\n client.onMessage(async message => {\n if (message.body === 'Hi') {\n await client.sendText(message.from, '\ud83d\udc4b Hello!');\n }\n });\n}\n\ncreate().then(start);\n\n"})}),"\n",(0,s.jsxs)(t.p,{children:["The method ",(0,s.jsx)(t.code,{children:"create"})," is what creates, authenticates/reloads a session. When you call create, make sure to keep an eye on the console output. In the console it will log the loading state of the client and the QR code (if there is no valid session data)."]}),"\n",(0,s.jsxs)(t.p,{children:["You can call ",(0,s.jsx)(t.code,{children:"create()"})," on it's own, however there are a bunch of powerful configuration variables you can set to acheive a more custom set up."]}),"\n",(0,s.jsx)(t.p,{children:"[[ConfigObject]]"}),"\n",(0,s.jsx)(t.p,{children:"Please note that you will be unable to scan the QR code if it is on a dark background."}),"\n",(0,s.jsx)(t.h2,{id:"what-happens-when-the-session-starts",children:"What happens when the session starts"}),"\n",(0,s.jsx)(t.p,{children:"In order to eliminate potential phishing attacks using this library, a message is sent to the host account from itself notifying the account user that the account is being managed/controlled using an automation software."}),"\n",(0,s.jsx)(t.p,{children:"This host notification will result in a CORS error in the browser instance. You can ignore the error."}),"\n",(0,s.jsxs)(t.p,{children:["Learn more here: ",(0,s.jsx)(t.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088",children:"https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088"})]})]})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var s=n(6540);const o={},i=s.createContext(o);function a(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54b7f2e2.1f7f3a9c.js b/assets/js/54b7f2e2.1f7f3a9c.js new file mode 100644 index 0000000000..0f09b20446 --- /dev/null +++ b/assets/js/54b7f2e2.1f7f3a9c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6496],{8892:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(4848),o=n(8453);const i={},c="Interface: Row",s={id:"reference/api/model/button/interfaces/Row",title:"Interface: Row",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Row.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Row",permalink:"/docs/reference/api/model/button/interfaces/Row",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Row.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody"},next:{title:"Interface: Section",permalink:"/docs/reference/api/model/button/interfaces/Section"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"rowId",id:"rowid",level:3},{value:"title",id:"title",level:3}];function a(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-row",children:"Interface: Row"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"description",children:"description"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"description"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"rowid",children:"rowId"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rowId"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>s});var r=n(6540);const o={},i=r.createContext(o);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54b7f2e2.a6144183.js b/assets/js/54b7f2e2.a6144183.js deleted file mode 100644 index 8ff539c836..0000000000 --- a/assets/js/54b7f2e2.a6144183.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6496],{8892:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(4848),o=n(8453);const i={},c="Interface: Row",s={id:"reference/api/model/button/interfaces/Row",title:"Interface: Row",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Row.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Row",permalink:"/docs/reference/api/model/button/interfaces/Row",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Row.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody"},next:{title:"Interface: Section",permalink:"/docs/reference/api/model/button/interfaces/Section"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"rowId",id:"rowid",level:3},{value:"title",id:"title",level:3}];function a(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-row",children:"Interface: Row"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"description",children:"description"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"description"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"rowid",children:"rowId"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rowId"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>s});var r=n(6540);const o={},i=r.createContext(o);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54d2ec5f.1c9453c5.js b/assets/js/54d2ec5f.1c9453c5.js new file mode 100644 index 0000000000..553449cf42 --- /dev/null +++ b/assets/js/54d2ec5f.1c9453c5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4711],{291:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var s=n(4848),o=n(8453);const t={},c="Interface: ProxyServerCredentials",i={id:"reference/api/model/config/interfaces/ProxyServerCredentials",title:"Interface: ProxyServerCredentials",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload"},next:{title:"Interface: SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"address",id:"address",level:3},{value:"password",id:"password",level:3},{value:"protocol?",id:"protocol",level:3},{value:"username",id:"username",level:3}];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"interface-proxyservercredentials",children:"Interface: ProxyServerCredentials"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"address",children:"address"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"address"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Proxy Server address. This can include the port e.g '127.0.0.1:5005'"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"password"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Password for Proxy Server authentication"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"protocol",children:"protocol?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"protocol"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The protocol on which the proxy is running. E.g ",(0,s.jsx)(r.code,{children:"http"}),", ",(0,s.jsx)(r.code,{children:"https"}),", ",(0,s.jsx)(r.code,{children:"socks4"})," or ",(0,s.jsx)(r.code,{children:"socks5"}),". This is optional and can be automatically determined from the address."]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"username"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Username for Proxy Server authentication"})]})}function h(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>c,x:()=>i});var s=n(6540);const o={},t=s.createContext(o);function c(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54d2ec5f.bc75da2b.js b/assets/js/54d2ec5f.bc75da2b.js deleted file mode 100644 index f276637ea2..0000000000 --- a/assets/js/54d2ec5f.bc75da2b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4711],{291:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var s=n(4848),o=n(8453);const t={},c="Interface: ProxyServerCredentials",i={id:"reference/api/model/config/interfaces/ProxyServerCredentials",title:"Interface: ProxyServerCredentials",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload"},next:{title:"Interface: SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"address",id:"address",level:3},{value:"password",id:"password",level:3},{value:"protocol?",id:"protocol",level:3},{value:"username",id:"username",level:3}];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"interface-proxyservercredentials",children:"Interface: ProxyServerCredentials"}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"address",children:"address"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"address"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Proxy Server address. This can include the port e.g '127.0.0.1:5005'"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"password"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Password for Proxy Server authentication"}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"protocol",children:"protocol?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"protocol"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["The protocol on which the proxy is running. E.g ",(0,s.jsx)(r.code,{children:"http"}),", ",(0,s.jsx)(r.code,{children:"https"}),", ",(0,s.jsx)(r.code,{children:"socks4"})," or ",(0,s.jsx)(r.code,{children:"socks5"}),". This is optional and can be automatically determined from the address."]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"username"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Username for Proxy Server authentication"})]})}function h(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>c,x:()=>i});var s=n(6540);const o={},t=s.createContext(o);function c(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57a2de75.0d0a825e.js b/assets/js/57a2de75.0d0a825e.js new file mode 100644 index 0000000000..985e7b9915 --- /dev/null +++ b/assets/js/57a2de75.0d0a825e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2147],{6863:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=n(4848),i=n(8453);const s={},o="Variable: configWithCases",c={id:"reference/controllers/initializer/variables/configWithCases",title:"Variable: configWithCases",description:"const configWithCases: any",source:"@site/docs/reference/controllers/initializer/variables/configWithCases.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/configWithCases.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: timeout()",permalink:"/docs/reference/controllers/initializer/functions/timeout"},next:{title:"Variable: pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg"}},a={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"variable-configwithcases",children:"Variable: configWithCases"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"const"})," ",(0,r.jsx)(t.strong,{children:"configWithCases"}),": ",(0,r.jsx)(t.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57a2de75.ae63e394.js b/assets/js/57a2de75.ae63e394.js deleted file mode 100644 index 1452cc0965..0000000000 --- a/assets/js/57a2de75.ae63e394.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2147],{6863:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=n(4848),r=n(8453);const s={},o="Variable: configWithCases",c={id:"reference/controllers/initializer/variables/configWithCases",title:"Variable: configWithCases",description:"const configWithCases: any",source:"@site/docs/reference/controllers/initializer/variables/configWithCases.md",sourceDirName:"reference/controllers/initializer/variables",slug:"/reference/controllers/initializer/variables/configWithCases",permalink:"/docs/reference/controllers/initializer/variables/configWithCases",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/variables/configWithCases.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: timeout()",permalink:"/docs/reference/controllers/initializer/functions/timeout"},next:{title:"Variable: pkg",permalink:"/docs/reference/controllers/initializer/variables/pkg"}},a={},l=[];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"variable-configwithcases",children:"Variable: configWithCases"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"const"})," ",(0,i.jsx)(t.strong,{children:"configWithCases"}),": ",(0,i.jsx)(t.code,{children:"any"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var i=n(6540);const r={},s=i.createContext(r);function o(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/58bfaad8.b1767845.js b/assets/js/58bfaad8.b1767845.js new file mode 100644 index 0000000000..eb57052fe5 --- /dev/null +++ b/assets/js/58bfaad8.b1767845.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86],{8146:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>d});var r=l(4848),i=l(8453);const c={},s="Interface: Call",t={id:"reference/api/model/call/interfaces/Call",title:"Interface: Call",description:"Properties",source:"@site/docs/reference/api/model/call/interfaces/Call.md",sourceDirName:"reference/api/model/call/interfaces",slug:"/reference/api/model/call/interfaces/Call",permalink:"/docs/reference/api/model/call/interfaces/Call",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/interfaces/Call.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState"},next:{title:"api/model/chat",permalink:"/docs/reference/api/model/chat/"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"State",id:"state",level:3},{value:"canHandleLocally",id:"canhandlelocally",level:3},{value:"id",id:"id",level:3},{value:"isGroup",id:"isgroup",level:3},{value:"isVideo",id:"isvideo",level:3},{value:"offerTime",id:"offertime",level:3},{value:"outgoing",id:"outgoing",level:3},{value:"participants",id:"participants",level:3},{value:"peerJid",id:"peerjid",level:3},{value:"webClientShouldHandle",id:"webclientshouldhandle",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-call",children:"Interface: Call"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"State"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:(0,r.jsx)(n.code,{children:"CallState"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"State of the call"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"canhandlelocally",children:"canHandleLocally"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"canHandleLocally"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The id of the call"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isGroup"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Whether or not the call is a group call"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isvideo",children:"isVideo"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isVideo"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Whether or not the call is a video call"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"offertime",children:"offerTime"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"offerTime"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The epoch timestamp of the call. You will have to multiply this by 1000 to get the actual epoch timestamp"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"outgoing",children:"outgoing"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"outgoing"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The direction of the call."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"participants",children:"participants"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"participants"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The other participants on a group call"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"peerjid",children:"peerJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"peerJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The id of the account calling"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"webclientshouldhandle",children:"webClientShouldHandle"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"webClientShouldHandle"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>t});var r=l(6540);const i={},c=r.createContext(i);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/58bfaad8.f8887102.js b/assets/js/58bfaad8.f8887102.js deleted file mode 100644 index 42bc3a100b..0000000000 --- a/assets/js/58bfaad8.f8887102.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86],{8146:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>d});var i=l(4848),r=l(8453);const c={},s="Interface: Call",t={id:"reference/api/model/call/interfaces/Call",title:"Interface: Call",description:"Properties",source:"@site/docs/reference/api/model/call/interfaces/Call.md",sourceDirName:"reference/api/model/call/interfaces",slug:"/reference/api/model/call/interfaces/Call",permalink:"/docs/reference/api/model/call/interfaces/Call",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/interfaces/Call.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState"},next:{title:"api/model/chat",permalink:"/docs/reference/api/model/chat/"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"State",id:"state",level:3},{value:"canHandleLocally",id:"canhandlelocally",level:3},{value:"id",id:"id",level:3},{value:"isGroup",id:"isgroup",level:3},{value:"isVideo",id:"isvideo",level:3},{value:"offerTime",id:"offertime",level:3},{value:"outgoing",id:"outgoing",level:3},{value:"participants",id:"participants",level:3},{value:"peerJid",id:"peerjid",level:3},{value:"webClientShouldHandle",id:"webclientshouldhandle",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-call",children:"Interface: Call"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:(0,i.jsx)(n.code,{children:"CallState"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"State of the call"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"canhandlelocally",children:"canHandleLocally"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"canHandleLocally"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the call"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isgroup",children:"isGroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isGroup"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether or not the call is a group call"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isvideo",children:"isVideo"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isVideo"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether or not the call is a video call"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"offertime",children:"offerTime"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"offerTime"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The epoch timestamp of the call. You will have to multiply this by 1000 to get the actual epoch timestamp"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"outgoing",children:"outgoing"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"outgoing"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The direction of the call."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"participants",children:"participants"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"participants"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The other participants on a group call"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"peerjid",children:"peerJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"peerJid"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The id of the account calling"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"webclientshouldhandle",children:"webClientShouldHandle"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"webClientShouldHandle"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>t});var i=l(6540);const r={},c=i.createContext(r);function s(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/59362658.2b3b4a54.js b/assets/js/59362658.2b3b4a54.js new file mode 100644 index 0000000000..171455bc9c --- /dev/null +++ b/assets/js/59362658.2b3b4a54.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9325],{1180:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=o(4848),n=o(8453);const r={slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},a=void 0,c={permalink:"/blog/mdx-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx",source:"@site/blog/2021-08-01-mdx-blog-post.mdx",title:"MDX Blog Post",description:"Blog posts support Docusaurus Markdown features, such as MDX.",date:"2021-08-01T00:00:00.000Z",tags:[{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.175,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber",page:null}],frontMatter:{slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},unlisted:!1,prevItem:{title:"Welcome",permalink:"/blog/welcome"},nextItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},u={authorsImageUrls:[void 0]},l=[];function i(t){const e={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,n.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(e.p,{children:["Blog posts support ",(0,s.jsx)(e.a,{href:"https://docusaurus.io/docs/markdown-features",children:"Docusaurus Markdown features"}),", such as ",(0,s.jsx)(e.a,{href:"https://mdxjs.com/",children:"MDX"}),"."]}),"\n",(0,s.jsxs)(e.admonition,{type:"tip",children:[(0,s.jsx)(e.p,{children:"Use the power of React to create interactive blog posts."}),(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-js",children:"\n"})}),(0,s.jsx)("button",{onClick:()=>alert("button clicked!"),children:"Click me!"})]})]})}function d(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(i,{...t})}):i(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>c});var s=o(6540);const n={},r=s.createContext(n);function a(t){const e=s.useContext(r);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:a(t.components),s.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/59362658.5976569b.js b/assets/js/59362658.5976569b.js deleted file mode 100644 index 2a730c78e5..0000000000 --- a/assets/js/59362658.5976569b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9325],{1180:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>n,metadata:()=>c,toc:()=>l});var s=o(4848),r=o(8453);const n={slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},a=void 0,c={permalink:"/blog/mdx-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx",source:"@site/blog/2021-08-01-mdx-blog-post.mdx",title:"MDX Blog Post",description:"Blog posts support Docusaurus Markdown features, such as MDX.",date:"2021-08-01T00:00:00.000Z",tags:[{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.175,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber"}],frontMatter:{slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},unlisted:!1,prevItem:{title:"Welcome",permalink:"/blog/welcome"},nextItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},u={authorsImageUrls:[void 0]},l=[];function i(t){const e={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,r.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(e.p,{children:["Blog posts support ",(0,s.jsx)(e.a,{href:"https://docusaurus.io/docs/markdown-features",children:"Docusaurus Markdown features"}),", such as ",(0,s.jsx)(e.a,{href:"https://mdxjs.com/",children:"MDX"}),"."]}),"\n",(0,s.jsxs)(e.admonition,{type:"tip",children:[(0,s.jsx)(e.p,{children:"Use the power of React to create interactive blog posts."}),(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-js",children:"\n"})}),(0,s.jsx)("button",{onClick:()=>alert("button clicked!"),children:"Click me!"})]})]})}function d(t={}){const{wrapper:e}={...(0,r.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(i,{...t})}):i(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>c});var s=o(6540);const r={},n=s.createContext(r);function a(t){const e=s.useContext(n);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(r):t.components||r:a(t.components),s.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c868d36.3a87f299.js b/assets/js/5c868d36.3a87f299.js new file mode 100644 index 0000000000..c9ad9c8ff4 --- /dev/null +++ b/assets/js/5c868d36.3a87f299.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1974],{5254:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>i,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const n={sidebar_position:1},o="Create a Page",c={id:"tutorial-basics/create-a-page",title:"Create a Page",description:"Add Markdown or React files to src/pages to create a standalone page:",source:"@site/docs/tutorial-basics/create-a-page.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-page",permalink:"/docs/tutorial-basics/create-a-page",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-page.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Tutorial - Basics",permalink:"/docs/category/tutorial---basics"},next:{title:"Create a Document",permalink:"/docs/tutorial-basics/create-a-document"}},i={},d=[{value:"Create your first React Page",id:"create-your-first-react-page",level:2},{value:"Create your first Markdown Page",id:"create-your-first-markdown-page",level:2}];function l(e){const a={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(a.header,{children:(0,r.jsx)(a.h1,{id:"create-a-page",children:"Create a Page"})}),"\n",(0,r.jsxs)(a.p,{children:["Add ",(0,r.jsx)(a.strong,{children:"Markdown or React"})," files to ",(0,r.jsx)(a.code,{children:"src/pages"})," to create a ",(0,r.jsx)(a.strong,{children:"standalone page"}),":"]}),"\n",(0,r.jsxs)(a.ul,{children:["\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/index.js"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/"})]}),"\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/foo.md"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/foo"})]}),"\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/foo/bar.js"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/foo/bar"})]}),"\n"]}),"\n",(0,r.jsx)(a.h2,{id:"create-your-first-react-page",children:"Create your first React Page"}),"\n",(0,r.jsxs)(a.p,{children:["Create a file at ",(0,r.jsx)(a.code,{children:"src/pages/my-react-page.js"}),":"]}),"\n",(0,r.jsx)(a.pre,{children:(0,r.jsx)(a.code,{className:"language-jsx",metastring:'title="src/pages/my-react-page.js"',children:"import React from 'react';\nimport Layout from '@theme/Layout';\n\nexport default function MyReactPage() {\n return (\n \n

My React page

\n

This is a React page

\n
\n );\n}\n"})}),"\n",(0,r.jsxs)(a.p,{children:["A new page is now available at ",(0,r.jsx)(a.a,{href:"http://localhost:3000/my-react-page",children:"http://localhost:3000/my-react-page"}),"."]}),"\n",(0,r.jsx)(a.h2,{id:"create-your-first-markdown-page",children:"Create your first Markdown Page"}),"\n",(0,r.jsxs)(a.p,{children:["Create a file at ",(0,r.jsx)(a.code,{children:"src/pages/my-markdown-page.md"}),":"]}),"\n",(0,r.jsx)(a.pre,{children:(0,r.jsx)(a.code,{className:"language-mdx",metastring:'title="src/pages/my-markdown-page.md"',children:"# My Markdown page\n\nThis is a Markdown page\n"})}),"\n",(0,r.jsxs)(a.p,{children:["A new page is now available at ",(0,r.jsx)(a.a,{href:"http://localhost:3000/my-markdown-page",children:"http://localhost:3000/my-markdown-page"}),"."]})]})}function p(e={}){const{wrapper:a}={...(0,s.R)(),...e.components};return a?(0,r.jsx)(a,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,a,t)=>{t.d(a,{R:()=>o,x:()=>c});var r=t(6540);const s={},n=r.createContext(s);function o(e){const a=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function c(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(n.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c868d36.586b094f.js b/assets/js/5c868d36.586b094f.js deleted file mode 100644 index 503c30a248..0000000000 --- a/assets/js/5c868d36.586b094f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1974],{5254:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>i,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>l});var r=t(4848),s=t(8453);const n={sidebar_position:1},o="Create a Page",c={id:"tutorial-basics/create-a-page",title:"Create a Page",description:"Add Markdown or React files to src/pages to create a standalone page:",source:"@site/docs/tutorial-basics/create-a-page.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/create-a-page",permalink:"/docs/tutorial-basics/create-a-page",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-page.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Tutorial - Basics",permalink:"/docs/category/tutorial---basics"},next:{title:"Create a Document",permalink:"/docs/tutorial-basics/create-a-document"}},i={},l=[{value:"Create your first React Page",id:"create-your-first-react-page",level:2},{value:"Create your first Markdown Page",id:"create-your-first-markdown-page",level:2}];function d(e){const a={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(a.h1,{id:"create-a-page",children:"Create a Page"}),"\n",(0,r.jsxs)(a.p,{children:["Add ",(0,r.jsx)(a.strong,{children:"Markdown or React"})," files to ",(0,r.jsx)(a.code,{children:"src/pages"})," to create a ",(0,r.jsx)(a.strong,{children:"standalone page"}),":"]}),"\n",(0,r.jsxs)(a.ul,{children:["\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/index.js"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/"})]}),"\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/foo.md"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/foo"})]}),"\n",(0,r.jsxs)(a.li,{children:[(0,r.jsx)(a.code,{children:"src/pages/foo/bar.js"})," \u2192 ",(0,r.jsx)(a.code,{children:"localhost:3000/foo/bar"})]}),"\n"]}),"\n",(0,r.jsx)(a.h2,{id:"create-your-first-react-page",children:"Create your first React Page"}),"\n",(0,r.jsxs)(a.p,{children:["Create a file at ",(0,r.jsx)(a.code,{children:"src/pages/my-react-page.js"}),":"]}),"\n",(0,r.jsx)(a.pre,{children:(0,r.jsx)(a.code,{className:"language-jsx",metastring:'title="src/pages/my-react-page.js"',children:"import React from 'react';\nimport Layout from '@theme/Layout';\n\nexport default function MyReactPage() {\n return (\n \n

My React page

\n

This is a React page

\n
\n );\n}\n"})}),"\n",(0,r.jsxs)(a.p,{children:["A new page is now available at ",(0,r.jsx)(a.a,{href:"http://localhost:3000/my-react-page",children:"http://localhost:3000/my-react-page"}),"."]}),"\n",(0,r.jsx)(a.h2,{id:"create-your-first-markdown-page",children:"Create your first Markdown Page"}),"\n",(0,r.jsxs)(a.p,{children:["Create a file at ",(0,r.jsx)(a.code,{children:"src/pages/my-markdown-page.md"}),":"]}),"\n",(0,r.jsx)(a.pre,{children:(0,r.jsx)(a.code,{className:"language-mdx",metastring:'title="src/pages/my-markdown-page.md"',children:"# My Markdown page\n\nThis is a Markdown page\n"})}),"\n",(0,r.jsxs)(a.p,{children:["A new page is now available at ",(0,r.jsx)(a.a,{href:"http://localhost:3000/my-markdown-page",children:"http://localhost:3000/my-markdown-page"}),"."]})]})}function p(e={}){const{wrapper:a}={...(0,s.R)(),...e.components};return a?(0,r.jsx)(a,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,a,t)=>{t.d(a,{R:()=>o,x:()=>c});var r=t(6540);const s={},n=r.createContext(s);function o(e){const a=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function c(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(n.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5cc50a6c.ce595156.js b/assets/js/5cc50a6c.ce595156.js new file mode 100644 index 0000000000..9b500f900e --- /dev/null +++ b/assets/js/5cc50a6c.ce595156.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[907],{952:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=n(4848),i=n(8453);const o={},r="More examples",a={id:"how-to/misc",title:"More examples",description:"Simulate typing",source:"@site/docs/how-to/misc.md",sourceDirName:"how-to",slug:"/how-to/misc",permalink:"/docs/how-to/misc",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/misc.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Manage Participants",permalink:"/docs/how-to/manage-participants"},next:{title:"Reacting To Group Events",permalink:"/docs/how-to/react-to-group-events"}},c={},l=[{value:"Simulate typing",id:"simulate-typing",level:2},{value:"Load profile pics from server",id:"load-profile-pics-from-server",level:2},{value:"Listen to Read Receipts",id:"listen-to-read-receipts",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"more-examples",children:"More examples"})}),"\n",(0,s.jsx)(t.h2,{id:"simulate-typing",children:"Simulate typing"}),"\n",(0,s.jsx)(t.p,{children:"As of version 1.3.1 you can now simulate '...typing'"}),"\n",(0,s.jsx)(t.p,{children:"You need to pass the following params:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["chat id: ",(0,s.jsx)(t.a,{href:"mailto:xxxxx@c.us",children:"xxxxx@c.us"})]}),"\n",(0,s.jsx)(t.li,{children:"on: true or false"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Note: You need to manually turn this off!!!"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"//start '...typing'\nawait client.simulateTyping('xxxxx@c.us',true)\n//wait 3 seconds\n\n//stop '...typing'\nawait client.simulateTyping('xxxxx@c.us',false)\n"})}),"\n",(0,s.jsx)(t.h2,{id:"load-profile-pics-from-server",children:"Load profile pics from server"}),"\n",(0,s.jsx)(t.p,{children:"Generally, after the 20th chat in your WA, getChat methods do not retreive the chat picture. You need to get these from the WA servers. This is how you do it in v1.6.6^:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"client.getProfilePicFromServer('XXXXXXX-YYYYY@c.us')\n"})}),"\n",(0,s.jsx)(t.h2,{id:"listen-to-read-receipts",children:"Listen to Read Receipts"}),"\n",(0,s.jsx)(t.p,{children:"As of version 1.5.3 you can now listen in on the read state (or technically acknowledgement state) of the messages. As of writing the limitation is presumed to be on sent messages."}),"\n",(0,s.jsx)(t.p,{children:"The callback you set returns the whole raw message object."}),"\n",(0,s.jsx)(t.p,{children:"Here's how you do it."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"client.onAck((msg:any) => console.log(msg.id.toString(),msg.body,msg.ack))\n"})}),"\n",(0,s.jsx)(t.p,{children:"ack represents the acknoledgement state, of which there are 3."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"1 => Message Sent (1 tick)\n\n2 => Message Received by Recipient (2 ticks)\n\n3 => Message Read Receipt Confirmed (2 blue ticks)\n"})}),"\n",(0,s.jsx)(t.p,{children:"Note: You won't get 3 if the recipient has read receipts off."})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var s=n(6540);const i={},o=s.createContext(i);function r(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5cc50a6c.f1359c6e.js b/assets/js/5cc50a6c.f1359c6e.js deleted file mode 100644 index 91ea140926..0000000000 --- a/assets/js/5cc50a6c.f1359c6e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[907],{952:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=n(4848),i=n(8453);const o={},r="More examples",a={id:"how-to/misc",title:"More examples",description:"Simulate typing",source:"@site/docs/how-to/misc.md",sourceDirName:"how-to",slug:"/how-to/misc",permalink:"/docs/how-to/misc",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/misc.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Manage Participants",permalink:"/docs/how-to/manage-participants"},next:{title:"Reacting To Group Events",permalink:"/docs/how-to/react-to-group-events"}},c={},l=[{value:"Simulate typing",id:"simulate-typing",level:2},{value:"Load profile pics from server",id:"load-profile-pics-from-server",level:2},{value:"Listen to Read Receipts",id:"listen-to-read-receipts",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"more-examples",children:"More examples"}),"\n",(0,s.jsx)(t.h2,{id:"simulate-typing",children:"Simulate typing"}),"\n",(0,s.jsx)(t.p,{children:"As of version 1.3.1 you can now simulate '...typing'"}),"\n",(0,s.jsx)(t.p,{children:"You need to pass the following params:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["chat id: ",(0,s.jsx)(t.a,{href:"mailto:xxxxx@c.us",children:"xxxxx@c.us"})]}),"\n",(0,s.jsx)(t.li,{children:"on: true or false"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Note: You need to manually turn this off!!!"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"//start '...typing'\nawait client.simulateTyping('xxxxx@c.us',true)\n//wait 3 seconds\n\n//stop '...typing'\nawait client.simulateTyping('xxxxx@c.us',false)\n"})}),"\n",(0,s.jsx)(t.h2,{id:"load-profile-pics-from-server",children:"Load profile pics from server"}),"\n",(0,s.jsx)(t.p,{children:"Generally, after the 20th chat in your WA, getChat methods do not retreive the chat picture. You need to get these from the WA servers. This is how you do it in v1.6.6^:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"client.getProfilePicFromServer('XXXXXXX-YYYYY@c.us')\n"})}),"\n",(0,s.jsx)(t.h2,{id:"listen-to-read-receipts",children:"Listen to Read Receipts"}),"\n",(0,s.jsx)(t.p,{children:"As of version 1.5.3 you can now listen in on the read state (or technically acknowledgement state) of the messages. As of writing the limitation is presumed to be on sent messages."}),"\n",(0,s.jsx)(t.p,{children:"The callback you set returns the whole raw message object."}),"\n",(0,s.jsx)(t.p,{children:"Here's how you do it."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"client.onAck((msg:any) => console.log(msg.id.toString(),msg.body,msg.ack))\n"})}),"\n",(0,s.jsx)(t.p,{children:"ack represents the acknoledgement state, of which there are 3."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-javascript",children:"1 => Message Sent (1 tick)\n\n2 => Message Received by Recipient (2 ticks)\n\n3 => Message Read Receipt Confirmed (2 blue ticks)\n"})}),"\n",(0,s.jsx)(t.p,{children:"Note: You won't get 3 if the recipient has read receipts off."})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var s=n(6540);const i={},o=s.createContext(i);function r(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e01f171.06ef2318.js b/assets/js/5e01f171.06ef2318.js new file mode 100644 index 0000000000..a4ba474021 --- /dev/null +++ b/assets/js/5e01f171.06ef2318.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1695],{3185:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var t=r(4848),s=r(8453);const c={},o="Enumeration: DIRECTORY_STRATEGY",i={id:"reference/api/model/config/enumerations/DIRECTORY_STRATEGY",title:"Enumeration: DIRECTORY\\_STRATEGY",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: CLOUD\\_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS"},next:{title:"Enumeration: LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType"}},d={},a=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CHAT",id:"chat",level:3},{value:"CHAT_DATE",id:"chat_date",level:3},{value:"DATE",id:"date",level:3},{value:"DATE_CHAT",id:"date_chat",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"enumeration-directory_strategy",children:"Enumeration: DIRECTORY_STRATEGY"})}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"chat",children:"CHAT"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHAT"}),": ",(0,t.jsx)(n.code,{children:'"CHAT"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/447123456789/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"chat_date",children:"CHAT_DATE"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHAT_DATE"}),": ",(0,t.jsx)(n.code,{children:'"CHAT_DATE"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/447123456789/2021-08-16/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"date",children:"DATE"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"DATE"}),": ",(0,t.jsx)(n.code,{children:'"DATE"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/2021-08-16/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"date_chat",children:"DATE_CHAT"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"DATE_CHAT"}),": ",(0,t.jsx)(n.code,{children:'"DATE_CHAT"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/2021-08-16/447123456789/"})]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>i});var t=r(6540);const s={},c=t.createContext(s);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e01f171.29888d96.js b/assets/js/5e01f171.29888d96.js deleted file mode 100644 index f7789fed6b..0000000000 --- a/assets/js/5e01f171.29888d96.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1695],{3185:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var t=r(4848),s=r(8453);const o={},c="Enumeration: DIRECTORY_STRATEGY",i={id:"reference/api/model/config/enumerations/DIRECTORY_STRATEGY",title:"Enumeration: DIRECTORY\\_STRATEGY",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: CLOUD\\_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS"},next:{title:"Enumeration: LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType"}},d={},a=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CHAT",id:"chat",level:3},{value:"CHAT_DATE",id:"chat_date",level:3},{value:"DATE",id:"date",level:3},{value:"DATE_CHAT",id:"date_chat",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-directory_strategy",children:"Enumeration: DIRECTORY_STRATEGY"}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"chat",children:"CHAT"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHAT"}),": ",(0,t.jsx)(n.code,{children:'"CHAT"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/447123456789/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"chat_date",children:"CHAT_DATE"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHAT_DATE"}),": ",(0,t.jsx)(n.code,{children:'"CHAT_DATE"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/447123456789/2021-08-16/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"date",children:"DATE"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"DATE"}),": ",(0,t.jsx)(n.code,{children:'"DATE"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/2021-08-16/"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"date_chat",children:"DATE_CHAT"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"DATE_CHAT"}),": ",(0,t.jsx)(n.code,{children:'"DATE_CHAT"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["E.g ",(0,t.jsx)(n.code,{children:"/2021-08-16/447123456789/"})]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>i});var t=r(6540);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.4f2a9a30.js b/assets/js/5e8c322a.4f2a9a30.js deleted file mode 100644 index c856d5f005..0000000000 --- a/assets/js/5e8c322a.4f2a9a30.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[594],{3478:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>t});var r=n(4848),a=n(8453);const l={},d="@open-wa/wa-automate v4.71.15",s={id:"api/index",title:"@open-wa/wa-automate v4.71.15",description:"Modules",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/docs/api/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/api/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Chatwoot integrations",permalink:"/docs/Integrations/chatwoot"},next:{title:"Creating an API",permalink:"/docs/how-to/create-api"}},o={},t=[{value:"Modules",id:"modules",level:2}];function c(e){const i={a:"a",h1:"h1",h2:"h2",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h1,{id:"open-wawa-automate-v47115",children:"@open-wa/wa-automate v4.71.15"}),"\n",(0,r.jsx)(i.h2,{id:"modules",children:"Modules"}),"\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/Client/index.md",children:"api/Client"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/functions/exposed.enum/index.md",children:"api/functions/exposed.enum"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/index.md",children:"api/model"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/aliases/index.md",children:"api/model/aliases"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/button/index.md",children:"api/model/button"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/call/index.md",children:"api/model/call"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/chat/index.md",children:"api/model/chat"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/config/index.md",children:"api/model/config"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/contact/index.md",children:"api/model/contact"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/errors/index.md",children:"api/model/errors"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/events/index.md",children:"api/model/events"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/group-metadata/index.md",children:"api/model/group-metadata"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/id/index.md",children:"api/model/id"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/label/index.md",children:"api/model/label"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/media/index.md",children:"api/model/media"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/message/index.md",children:"api/model/message"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/product/index.md",children:"api/model/product"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/reactions/index.md",children:"api/model/reactions"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/sessionInfo/index.md",children:"api/model/sessionInfo"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/events/index.md",children:"controllers/events"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/init_patch/index.md",children:"controllers/init_patch"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/initializer/index.md",children:"controllers/initializer"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/patch_manager/index.md",children:"controllers/patch_manager"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/logging/custom_transport/index.md",children:"logging/custom_transport"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/logging/logging/index.md",children:"logging/logging"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/Collector/index.md",children:"structures/Collector"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/Dialog/index.md",children:"structures/Dialog"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/MessageCollector/index.md",children:"structures/MessageCollector"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/preProcessors/index.md",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:i}={...(0,a.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>s});var r=n(6540);const a={},l=r.createContext(a);function d(e){const i=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function s(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:d(e.components),r.createElement(l.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.d63c5195.js b/assets/js/5e8c322a.d63c5195.js new file mode 100644 index 0000000000..49120ba53b --- /dev/null +++ b/assets/js/5e8c322a.d63c5195.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[594],{3478:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>s,toc:()=>t});var r=n(4848),a=n(8453);const d={},l="@open-wa/wa-automate v4.71.15",s={id:"api/index",title:"@open-wa/wa-automate v4.71.15",description:"Modules",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/docs/api/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/api/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Chatwoot integrations",permalink:"/docs/Integrations/chatwoot"},next:{title:"Creating an API",permalink:"/docs/how-to/create-api"}},o={},t=[{value:"Modules",id:"modules",level:2}];function c(e){const i={a:"a",h1:"h1",h2:"h2",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"open-wawa-automate-v47115",children:"@open-wa/wa-automate v4.71.15"})}),"\n",(0,r.jsx)(i.h2,{id:"modules",children:"Modules"}),"\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/Client/index.md",children:"api/Client"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/functions/exposed.enum/index.md",children:"api/functions/exposed.enum"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/index.md",children:"api/model"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/aliases/index.md",children:"api/model/aliases"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/button/index.md",children:"api/model/button"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/call/index.md",children:"api/model/call"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/chat/index.md",children:"api/model/chat"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/config/index.md",children:"api/model/config"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/contact/index.md",children:"api/model/contact"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/errors/index.md",children:"api/model/errors"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/events/index.md",children:"api/model/events"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/group-metadata/index.md",children:"api/model/group-metadata"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/id/index.md",children:"api/model/id"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/label/index.md",children:"api/model/label"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/media/index.md",children:"api/model/media"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/message/index.md",children:"api/model/message"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/product/index.md",children:"api/model/product"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/reactions/index.md",children:"api/model/reactions"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/api/model/sessionInfo/index.md",children:"api/model/sessionInfo"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/events/index.md",children:"controllers/events"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/init_patch/index.md",children:"controllers/init_patch"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/initializer/index.md",children:"controllers/initializer"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/controllers/patch_manager/index.md",children:"controllers/patch_manager"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/logging/custom_transport/index.md",children:"logging/custom_transport"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/logging/logging/index.md",children:"logging/logging"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/Collector/index.md",children:"structures/Collector"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/Dialog/index.md",children:"structures/Dialog"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/MessageCollector/index.md",children:"structures/MessageCollector"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/api/structures/preProcessors/index.md",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:i}={...(0,a.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>s});var r=n(6540);const a={},d=r.createContext(a);function l(e){const i=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function s(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),r.createElement(d.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e95c892.6cd75dad.js b/assets/js/5e95c892.021b48f6.js similarity index 81% rename from assets/js/5e95c892.6cd75dad.js rename to assets/js/5e95c892.021b48f6.js index 32c4e943d8..6603fb2a27 100644 --- a/assets/js/5e95c892.6cd75dad.js +++ b/assets/js/5e95c892.021b48f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9647],{7121:(e,s,r)=>{r.r(s),r.d(s,{default:()=>l});r(6540);var c=r(4164),u=r(5500),a=r(7559),d=r(2831),n=r(9201),t=r(4848);function l(e){return(0,t.jsx)(u.e3,{className:(0,c.A)(a.G.wrapper.docsPages),children:(0,t.jsx)(n.A,{children:(0,d.v)(e.route.routes)})})}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9647],{7121:(e,s,r)=>{r.r(s),r.d(s,{default:()=>l});r(6540);var c=r(4164),u=r(5500),a=r(7559),d=r(2831),n=r(3277),t=r(4848);function l(e){return(0,t.jsx)(u.e3,{className:(0,c.A)(a.G.wrapper.docsPages),children:(0,t.jsx)(n.A,{children:(0,d.v)(e.route.routes)})})}}}]); \ No newline at end of file diff --git a/assets/js/5ebba8c8.1e5286c2.js b/assets/js/5ebba8c8.1e5286c2.js deleted file mode 100644 index 87caf1ff9d..0000000000 --- a/assets/js/5ebba8c8.1e5286c2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7615],{7892:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>p});var a=n(4848),i=n(8453);const r={},o="Group",c={id:"how-to/groups",title:"Group",description:"Create a Group",source:"@site/docs/how-to/groups.md",sourceDirName:"how-to",slug:"/how-to/groups",permalink:"/docs/how-to/groups",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/groups.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Detecting Logouts",permalink:"/docs/how-to/detect-logout"},next:{title:"Error Handling",permalink:"/docs/how-to/handle-errors"}},s={},p=[{value:"Create a Group",id:"create-a-group",level:2},{value:"Managing Participants",id:"managing-participants",level:2},{value:"Listening to participant changes of a specific group",id:"listening-to-participant-changes-of-a-specific-group",level:2},{value:"Listen to participant changes globally",id:"listen-to-participant-changes-globally",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"group",children:"Group"}),"\n",(0,a.jsx)(t.h2,{id:"create-a-group",children:"Create a Group"}),"\n",(0,a.jsx)(t.p,{children:"Use [[createGroup]] to create a new group, first parameter is the group name, the second parameter is the contact ids to add as participants. There needs to be at least one participant."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"...\n client.createGroup('Cool new group','xxxxxxxxx@c.us') //you can also send an array of ids.\n...\n"})}),"\n",(0,a.jsx)(t.h2,{id:"managing-participants",children:"Managing Participants"}),"\n",(0,a.jsx)(t.p,{children:"[[addParticipant]] - add a participant\n[[removeParticipant]] - remove a particpant\n[[promoteParticipant]] - Make a participant admin\n[[demoteParticipant]] - remove participant as admin"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"...\n client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n...\n"})}),"\n",(0,a.jsx)(t.h2,{id:"listening-to-participant-changes-of-a-specific-group",children:"Listening to participant changes of a specific group"}),"\n",(0,a.jsx)(t.p,{children:"You can react to when participants are added and removed. [[onParticipantsChanged]] emits a [[ParticipantChangedEventModel]]."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"client.onParticipantsChanged(\"XXXXXXXX-YYYYYYYY@g.us\", (participantChangedEvent) => console.log(\"participant changed for group\", participantChangedEvent));\n\n//participantChangedEvent returns\n{\n by: 'XXXXXXXXXXX@c.us', //who performed the action\n action: 'remove',\n who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.\n}\n"})}),"\n",(0,a.jsx)(t.p,{children:"This solution can result in some false positives and misfires however a lot of effort has been made to mitigate this to a reasonable level. Best practice is to maintian a seperate registry of participants and go from that."}),"\n",(0,a.jsx)(t.h2,{id:"listen-to-participant-changes-globally",children:"Listen to participant changes globally"}),"\n",(0,a.jsx)(t.p,{children:"[[onGlobalParticipantsChanged]] is a simple and memory efficient way to listen to all participant changes from all groups. This is an Insider's Feature."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"client.onGlobalParticipantsChanged((participantChangedEvent) => console.log(\"participant changed for group\", participantChangedEvent));\n\n//participantChangedEvent returns\n{\n by: 'XXXXXXXXXXX@c.us', //who performed the action\n action: 'remove',\n who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.\n}\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var a=n(6540);const i={},r=a.createContext(i);function o(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5ebba8c8.b0f328c5.js b/assets/js/5ebba8c8.b0f328c5.js new file mode 100644 index 0000000000..454aa14f15 --- /dev/null +++ b/assets/js/5ebba8c8.b0f328c5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7615],{7892:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>p});var a=n(4848),i=n(8453);const r={},o="Group",c={id:"how-to/groups",title:"Group",description:"Create a Group",source:"@site/docs/how-to/groups.md",sourceDirName:"how-to",slug:"/how-to/groups",permalink:"/docs/how-to/groups",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/groups.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Detecting Logouts",permalink:"/docs/how-to/detect-logout"},next:{title:"Error Handling",permalink:"/docs/how-to/handle-errors"}},s={},p=[{value:"Create a Group",id:"create-a-group",level:2},{value:"Managing Participants",id:"managing-participants",level:2},{value:"Listening to participant changes of a specific group",id:"listening-to-participant-changes-of-a-specific-group",level:2},{value:"Listen to participant changes globally",id:"listen-to-participant-changes-globally",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"group",children:"Group"})}),"\n",(0,a.jsx)(t.h2,{id:"create-a-group",children:"Create a Group"}),"\n",(0,a.jsx)(t.p,{children:"Use [[createGroup]] to create a new group, first parameter is the group name, the second parameter is the contact ids to add as participants. There needs to be at least one participant."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"...\n client.createGroup('Cool new group','xxxxxxxxx@c.us') //you can also send an array of ids.\n...\n"})}),"\n",(0,a.jsx)(t.h2,{id:"managing-participants",children:"Managing Participants"}),"\n",(0,a.jsx)(t.p,{children:"[[addParticipant]] - add a participant\n[[removeParticipant]] - remove a particpant\n[[promoteParticipant]] - Make a participant admin\n[[demoteParticipant]] - remove participant as admin"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"...\n client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n...\n"})}),"\n",(0,a.jsx)(t.h2,{id:"listening-to-participant-changes-of-a-specific-group",children:"Listening to participant changes of a specific group"}),"\n",(0,a.jsx)(t.p,{children:"You can react to when participants are added and removed. [[onParticipantsChanged]] emits a [[ParticipantChangedEventModel]]."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"client.onParticipantsChanged(\"XXXXXXXX-YYYYYYYY@g.us\", (participantChangedEvent) => console.log(\"participant changed for group\", participantChangedEvent));\n\n//participantChangedEvent returns\n{\n by: 'XXXXXXXXXXX@c.us', //who performed the action\n action: 'remove',\n who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.\n}\n"})}),"\n",(0,a.jsx)(t.p,{children:"This solution can result in some false positives and misfires however a lot of effort has been made to mitigate this to a reasonable level. Best practice is to maintian a seperate registry of participants and go from that."}),"\n",(0,a.jsx)(t.h2,{id:"listen-to-participant-changes-globally",children:"Listen to participant changes globally"}),"\n",(0,a.jsx)(t.p,{children:"[[onGlobalParticipantsChanged]] is a simple and memory efficient way to listen to all participant changes from all groups. This is an Insider's Feature."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-javascript",children:"client.onGlobalParticipantsChanged((participantChangedEvent) => console.log(\"participant changed for group\", participantChangedEvent));\n\n//participantChangedEvent returns\n{\n by: 'XXXXXXXXXXX@c.us', //who performed the action\n action: 'remove',\n who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.\n}\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var a=n(6540);const i={},r=a.createContext(i);function o(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5f2ffadc.74e59d6e.js b/assets/js/5f2ffadc.74e59d6e.js deleted file mode 100644 index 55802ad192..0000000000 --- a/assets/js/5f2ffadc.74e59d6e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9850],{8320:(t,o,e)=>{e.r(o),e.d(o,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>u});var n=e(4848),s=e(8453);const r={},i="How does this work?",c={id:"concepts/how-it-works",title:"How does this work?",description:'wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the "Client". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.',source:"@site/docs/concepts/how-it-works.md",sourceDirName:"concepts",slug:"/concepts/how-it-works",permalink:"/docs/concepts/how-it-works",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/concepts/how-it-works.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Glossary",permalink:"/docs/concepts/glossary"},next:{title:"Easy API",permalink:"/docs/get-started/quick-run"}},a={},u=[];function d(t){const o={h1:"h1",p:"p",...(0,s.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"how-does-this-work",children:"How does this work?"}),"\n",(0,n.jsx)(o.p,{children:'wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the "Client". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.'})]})}function h(t={}){const{wrapper:o}={...(0,s.R)(),...t.components};return o?(0,n.jsx)(o,{...t,children:(0,n.jsx)(d,{...t})}):d(t)}},8453:(t,o,e)=>{e.d(o,{R:()=>i,x:()=>c});var n=e(6540);const s={},r=n.createContext(s);function i(t){const o=n.useContext(r);return n.useMemo((function(){return"function"==typeof t?t(o):{...o,...t}}),[o,t])}function c(t){let o;return o=t.disableParentContext?"function"==typeof t.components?t.components(s):t.components||s:i(t.components),n.createElement(r.Provider,{value:o},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/5f2ffadc.aec42721.js b/assets/js/5f2ffadc.aec42721.js new file mode 100644 index 0000000000..2327a52b70 --- /dev/null +++ b/assets/js/5f2ffadc.aec42721.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9850],{8320:(t,o,e)=>{e.r(o),e.d(o,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=e(4848),r=e(8453);const s={},i="How does this work?",c={id:"concepts/how-it-works",title:"How does this work?",description:'wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the "Client". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.',source:"@site/docs/concepts/how-it-works.md",sourceDirName:"concepts",slug:"/concepts/how-it-works",permalink:"/docs/concepts/how-it-works",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/concepts/how-it-works.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Glossary",permalink:"/docs/concepts/glossary"},next:{title:"Easy API",permalink:"/docs/get-started/quick-run"}},a={},u=[];function d(t){const o={h1:"h1",header:"header",p:"p",...(0,r.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.header,{children:(0,n.jsx)(o.h1,{id:"how-does-this-work",children:"How does this work?"})}),"\n",(0,n.jsx)(o.p,{children:'wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the "Client". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.'})]})}function h(t={}){const{wrapper:o}={...(0,r.R)(),...t.components};return o?(0,n.jsx)(o,{...t,children:(0,n.jsx)(d,{...t})}):d(t)}},8453:(t,o,e)=>{e.d(o,{R:()=>i,x:()=>c});var n=e(6540);const r={},s=n.createContext(r);function i(t){const o=n.useContext(s);return n.useMemo((function(){return"function"==typeof t?t(o):{...o,...t}}),[o,t])}function c(t){let o;return o=t.disableParentContext?"function"==typeof t.components?t.components(r):t.components||r:i(t.components),n.createElement(s.Provider,{value:o},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/5f617a4c.66e75767.js b/assets/js/5f617a4c.66e75767.js new file mode 100644 index 0000000000..45b245b786 --- /dev/null +++ b/assets/js/5f617a4c.66e75767.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3814],{6910:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var c=r(4848),t=r(8453);const o={},s="Function: earlyInjectionCheck()",a={id:"reference/controllers/patch_manager/functions/earlyInjectionCheck",title:"Function: earlyInjectionCheck()",description:"earlyInjectionCheck(page): Promise\\ boolean\\>",source:"@site/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",sourceDirName:"reference/controllers/patch_manager/functions",slug:"/reference/controllers/patch_manager/functions/earlyInjectionCheck",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/patch\\_manager",permalink:"/docs/reference/controllers/patch_manager/"},next:{title:"Function: getAndInjectLicense()",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{children:(0,c.jsx)(n.h1,{id:"function-earlyinjectioncheck",children:"Function: earlyInjectionCheck()"})}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"earlyInjectionCheck"}),"(",(0,c.jsx)(n.code,{children:"page"}),"): ",(0,c.jsx)(n.code,{children:"Promise"}),"<(",(0,c.jsx)(n.code,{children:"page"}),") => ",(0,c.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"page"}),": ",(0,c.jsx)(n.code,{children:"Page"})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"<(",(0,c.jsx)(n.code,{children:"page"}),") => ",(0,c.jsx)(n.code,{children:"boolean"}),">"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var c=r(6540);const t={},o=c.createContext(t);function s(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5f617a4c.8c23062f.js b/assets/js/5f617a4c.8c23062f.js deleted file mode 100644 index 266c566246..0000000000 --- a/assets/js/5f617a4c.8c23062f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3814],{6910:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var c=r(4848),t=r(8453);const o={},s="Function: earlyInjectionCheck()",a={id:"reference/controllers/patch_manager/functions/earlyInjectionCheck",title:"Function: earlyInjectionCheck()",description:"earlyInjectionCheck(page): Promise\\ boolean\\>",source:"@site/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",sourceDirName:"reference/controllers/patch_manager/functions",slug:"/reference/controllers/patch_manager/functions/earlyInjectionCheck",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/patch\\_manager",permalink:"/docs/reference/controllers/patch_manager/"},next:{title:"Function: getAndInjectLicense()",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-earlyinjectioncheck",children:"Function: earlyInjectionCheck()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"earlyInjectionCheck"}),"(",(0,c.jsx)(n.code,{children:"page"}),"): ",(0,c.jsx)(n.code,{children:"Promise"}),"<(",(0,c.jsx)(n.code,{children:"page"}),") => ",(0,c.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"page"}),": ",(0,c.jsx)(n.code,{children:"Page"})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"<(",(0,c.jsx)(n.code,{children:"page"}),") => ",(0,c.jsx)(n.code,{children:"boolean"}),">"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var c=r(6540);const t={},o=c.createContext(t);function s(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fd2b997.65f34c22.js b/assets/js/5fd2b997.65f34c22.js deleted file mode 100644 index 333ac2763c..0000000000 --- a/assets/js/5fd2b997.65f34c22.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[707],{3160:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=o(4848),r=o(8453);const s={},i="Function: addRotateFileLogTransport()",c={id:"reference/logging/logging/functions/addRotateFileLogTransport",title:"Function: addRotateFileLogTransport()",description:"addRotateFileLogTransport(options): void",source:"@site/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",sourceDirName:"reference/logging/logging/functions",slug:"/reference/logging/logging/functions/addRotateFileLogTransport",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"logging/logging",permalink:"/docs/reference/logging/logging/"},next:{title:"Type Alias: ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function g(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-addrotatefilelogtransport",children:"Function: addRotateFileLogTransport()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"addRotateFileLogTransport"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"any"})," = ",(0,t.jsx)(n.code,{children:"{}"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>c});var t=o(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fd2b997.96eb9701.js b/assets/js/5fd2b997.96eb9701.js new file mode 100644 index 0000000000..494483b66e --- /dev/null +++ b/assets/js/5fd2b997.96eb9701.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[707],{3160:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=o(4848),r=o(8453);const s={},i="Function: addRotateFileLogTransport()",a={id:"reference/logging/logging/functions/addRotateFileLogTransport",title:"Function: addRotateFileLogTransport()",description:"addRotateFileLogTransport(options): void",source:"@site/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",sourceDirName:"reference/logging/logging/functions",slug:"/reference/logging/logging/functions/addRotateFileLogTransport",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"logging/logging",permalink:"/docs/reference/logging/logging/"},next:{title:"Type Alias: ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function g(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-addrotatefilelogtransport",children:"Function: addRotateFileLogTransport()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"addRotateFileLogTransport"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"any"})," = ",(0,t.jsx)(n.code,{children:"{}"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>a});var t=o(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60a6a9a9.2a5c11e4.js b/assets/js/60a6a9a9.2a5c11e4.js new file mode 100644 index 0000000000..d826febed5 --- /dev/null +++ b/assets/js/60a6a9a9.2a5c11e4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8444],{6031:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>s});var r=t(4848),a=t(8453);const c={},i="Interface: ParticipantChangedEventModel",o={id:"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",title:"Interface: ParticipantChangedEventModel",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant"},next:{title:"api/model/id",permalink:"/docs/reference/api/model/id/"}},d={},s=[{value:"Properties",id:"properties",level:2},{value:"action",id:"action",level:3},{value:"by",id:"by",level:3},{value:"chat",id:"chat",level:3},{value:"who",id:"who",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-participantchangedeventmodel",children:"Interface: ParticipantChangedEventModel"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"action",children:"action"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"action"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",children:(0,r.jsx)(n.code,{children:"groupChangeEvent"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"by",children:"by"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"by"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chat",children:"chat"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"chat"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(n.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"who",children:"who"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"who"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})}),"[]"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>o});var r=t(6540);const a={},c=r.createContext(a);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60a6a9a9.a91814c7.js b/assets/js/60a6a9a9.a91814c7.js deleted file mode 100644 index 2d16f822fb..0000000000 --- a/assets/js/60a6a9a9.a91814c7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8444],{6031:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=t(4848),a=t(8453);const c={},i="Interface: ParticipantChangedEventModel",o={id:"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",title:"Interface: ParticipantChangedEventModel",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",permalink:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant"},next:{title:"api/model/id",permalink:"/docs/reference/api/model/id/"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"action",id:"action",level:3},{value:"by",id:"by",level:3},{value:"chat",id:"chat",level:3},{value:"who",id:"who",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-participantchangedeventmodel",children:"Interface: ParticipantChangedEventModel"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"action",children:"action"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"action"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",children:(0,r.jsx)(n.code,{children:"groupChangeEvent"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"by",children:"by"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"by"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chat",children:"chat"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"chat"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(n.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"who",children:"who"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"who"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})}),"[]"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>o});var r=t(6540);const a={},c=r.createContext(a);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60b52a9d.77934ac5.js b/assets/js/60b52a9d.77934ac5.js new file mode 100644 index 0000000000..7a7a558fa7 --- /dev/null +++ b/assets/js/60b52a9d.77934ac5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6002],{3290:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>a,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=s(4848),i=s(8453);const o={},t="Enumeration: STATE",c={id:"reference/api/model/enumerations/STATE",title:"Enumeration: STATE",description:"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren't understood completely.",source:"@site/docs/reference/api/model/enumerations/STATE.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/STATE",permalink:"/docs/reference/api/model/enumerations/STATE",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/STATE.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: Events",permalink:"/docs/reference/api/model/enumerations/Events"},next:{title:"Enumeration: Status",permalink:"/docs/reference/api/model/enumerations/Status"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CONFLICT",id:"conflict",level:3},{value:"CONNECTED",id:"connected",level:3},{value:"DEPRECATED_VERSION",id:"deprecated_version",level:3},{value:"DISCONNECTED",id:"disconnected",level:3},{value:"OPENING",id:"opening",level:3},{value:"PAIRING",id:"pairing",level:3},{value:"PROXYBLOCK",id:"proxyblock",level:3},{value:"SMB_TOS_BLOCK",id:"smb_tos_block",level:3},{value:"SYNCING",id:"syncing",level:3},{value:"TIMEOUT",id:"timeout",level:3},{value:"TOS_BLOCK",id:"tos_block",level:3},{value:"UNLAUNCHED",id:"unlaunched",level:3},{value:"UNPAIRED",id:"unpaired",level:3},{value:"UNPAIRED_IDLE",id:"unpaired_idle",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-state",children:"Enumeration: STATE"})}),"\n",(0,r.jsx)(n.p,{children:"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren't understood completely."}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"conflict",children:"CONFLICT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONFLICT"}),": ",(0,r.jsx)(n.code,{children:'"CONFLICT"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Another WA web session has been opened for this account somewhere else."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"connected",children:"CONNECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONNECTED"}),": ",(0,r.jsx)(n.code,{children:'"CONNECTED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The session is successfully connected and ready to send and receive messages."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deprecated_version",children:"DEPRECATED_VERSION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DEPRECATED_VERSION"}),": ",(0,r.jsx)(n.code,{children:'"DEPRECATED_VERSION"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"WA web updates every fortnight (or so). This state would be emitted then."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disconnected",children:"DISCONNECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DISCONNECTED"}),": ",(0,r.jsx)(n.code,{children:'"DISCONNECTED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This is fired when the connection between web and the host account primary device is disconnected. This is fired frequently to save battery."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"opening",children:"OPENING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"OPENING"}),": ",(0,r.jsx)(n.code,{children:'"OPENING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This probably shows up when reloading an already authenticated session."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pairing",children:"PAIRING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PAIRING"}),": ",(0,r.jsx)(n.code,{children:'"PAIRING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This probably shows up immediately after the QR code is scanned"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"proxyblock",children:"PROXYBLOCK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PROXYBLOCK"}),": ",(0,r.jsx)(n.code,{children:'"PROXYBLOCK"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This state probably represented a block on the proxy address your app is using."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"smb_tos_block",children:"SMB_TOS_BLOCK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"SMB_TOS_BLOCK"}),": ",(0,r.jsx)(n.code,{children:'"SMB_TOS_BLOCK"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. This is a different version of a Terms of Service Block from what we know. It may also show up when the host account is banned."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"syncing",children:"SYNCING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"SYNCING"}),": ",(0,r.jsx)(n.code,{children:'"SYNCING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This is fired when the QR code is scanned"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"timeout",children:"TIMEOUT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TIMEOUT"}),": ",(0,r.jsx)(n.code,{children:'"TIMEOUT"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The trigger for this state is as of yet unknown"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"tos_block",children:"TOS_BLOCK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"TOS_BLOCK"}),": ",(0,r.jsx)(n.code,{children:'"TOS_BLOCK"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. It literally stands for Terms of Service Block. It may also show up when the host account is banned."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unlaunched",children:"UNLAUNCHED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNLAUNCHED"}),": ",(0,r.jsx)(n.code,{children:'"UNLAUNCHED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The same (probably replacement) for CONFLICT"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unpaired",children:"UNPAIRED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNPAIRED"}),": ",(0,r.jsx)(n.code,{children:'"UNPAIRED"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["When ",(0,r.jsx)(n.code,{children:"UNPAIRED"})," the page is waiting for a QR Code scan. If your state becomes ",(0,r.jsx)(n.code,{children:"UNPAIRED"})," then the session is most likely signed out by the host account."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unpaired_idle",children:"UNPAIRED_IDLE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNPAIRED_IDLE"}),": ",(0,r.jsx)(n.code,{children:'"UNPAIRED_IDLE"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:'This state is fired when the QR code has not been scanned for a long time (about 1 minute). On the page it will show "Click to reload QR code"'})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var r=s(6540);const i={},o=r.createContext(i);function t(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60b52a9d.8917a7ea.js b/assets/js/60b52a9d.8917a7ea.js deleted file mode 100644 index 3717f09429..0000000000 --- a/assets/js/60b52a9d.8917a7ea.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6002],{3290:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>a,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=s(4848),r=s(8453);const o={},t="Enumeration: STATE",c={id:"reference/api/model/enumerations/STATE",title:"Enumeration: STATE",description:"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren't understood completely.",source:"@site/docs/reference/api/model/enumerations/STATE.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/STATE",permalink:"/docs/reference/api/model/enumerations/STATE",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/STATE.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: Events",permalink:"/docs/reference/api/model/enumerations/Events"},next:{title:"Enumeration: Status",permalink:"/docs/reference/api/model/enumerations/Status"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CONFLICT",id:"conflict",level:3},{value:"CONNECTED",id:"connected",level:3},{value:"DEPRECATED_VERSION",id:"deprecated_version",level:3},{value:"DISCONNECTED",id:"disconnected",level:3},{value:"OPENING",id:"opening",level:3},{value:"PAIRING",id:"pairing",level:3},{value:"PROXYBLOCK",id:"proxyblock",level:3},{value:"SMB_TOS_BLOCK",id:"smb_tos_block",level:3},{value:"SYNCING",id:"syncing",level:3},{value:"TIMEOUT",id:"timeout",level:3},{value:"TOS_BLOCK",id:"tos_block",level:3},{value:"UNLAUNCHED",id:"unlaunched",level:3},{value:"UNPAIRED",id:"unpaired",level:3},{value:"UNPAIRED_IDLE",id:"unpaired_idle",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"enumeration-state",children:"Enumeration: STATE"}),"\n",(0,i.jsx)(n.p,{children:"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren't understood completely."}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsx)(n.h3,{id:"conflict",children:"CONFLICT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CONFLICT"}),": ",(0,i.jsx)(n.code,{children:'"CONFLICT"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Another WA web session has been opened for this account somewhere else."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"connected",children:"CONNECTED"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CONNECTED"}),": ",(0,i.jsx)(n.code,{children:'"CONNECTED"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The session is successfully connected and ready to send and receive messages."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deprecated_version",children:"DEPRECATED_VERSION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DEPRECATED_VERSION"}),": ",(0,i.jsx)(n.code,{children:'"DEPRECATED_VERSION"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"WA web updates every fortnight (or so). This state would be emitted then."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"disconnected",children:"DISCONNECTED"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DISCONNECTED"}),": ",(0,i.jsx)(n.code,{children:'"DISCONNECTED"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This is fired when the connection between web and the host account primary device is disconnected. This is fired frequently to save battery."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"opening",children:"OPENING"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OPENING"}),": ",(0,i.jsx)(n.code,{children:'"OPENING"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This probably shows up when reloading an already authenticated session."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pairing",children:"PAIRING"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"PAIRING"}),": ",(0,i.jsx)(n.code,{children:'"PAIRING"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This probably shows up immediately after the QR code is scanned"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"proxyblock",children:"PROXYBLOCK"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"PROXYBLOCK"}),": ",(0,i.jsx)(n.code,{children:'"PROXYBLOCK"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This state probably represented a block on the proxy address your app is using."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"smb_tos_block",children:"SMB_TOS_BLOCK"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SMB_TOS_BLOCK"}),": ",(0,i.jsx)(n.code,{children:'"SMB_TOS_BLOCK"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. This is a different version of a Terms of Service Block from what we know. It may also show up when the host account is banned."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"syncing",children:"SYNCING"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SYNCING"}),": ",(0,i.jsx)(n.code,{children:'"SYNCING"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This is fired when the QR code is scanned"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"timeout",children:"TIMEOUT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TIMEOUT"}),": ",(0,i.jsx)(n.code,{children:'"TIMEOUT"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The trigger for this state is as of yet unknown"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tos_block",children:"TOS_BLOCK"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"TOS_BLOCK"}),": ",(0,i.jsx)(n.code,{children:'"TOS_BLOCK"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. It literally stands for Terms of Service Block. It may also show up when the host account is banned."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unlaunched",children:"UNLAUNCHED"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"UNLAUNCHED"}),": ",(0,i.jsx)(n.code,{children:'"UNLAUNCHED"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The same (probably replacement) for CONFLICT"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unpaired",children:"UNPAIRED"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"UNPAIRED"}),": ",(0,i.jsx)(n.code,{children:'"UNPAIRED"'})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["When ",(0,i.jsx)(n.code,{children:"UNPAIRED"})," the page is waiting for a QR Code scan. If your state becomes ",(0,i.jsx)(n.code,{children:"UNPAIRED"})," then the session is most likely signed out by the host account."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unpaired_idle",children:"UNPAIRED_IDLE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"UNPAIRED_IDLE"}),": ",(0,i.jsx)(n.code,{children:'"UNPAIRED_IDLE"'})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'This state is fired when the QR code has not been scanned for a long time (about 1 minute). On the page it will show "Click to reload QR code"'})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var i=s(6540);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/621db11d.341497fe.js b/assets/js/621db11d.341497fe.js new file mode 100644 index 0000000000..5143dfe22c --- /dev/null +++ b/assets/js/621db11d.341497fe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4212],{3250:(t,e,s)=>{s.r(e),s.d(e,{default:()=>m});s(6540);var a=s(4164),o=s(5500),r=s(7559),l=s(6461),u=s(8027),n=s(1463),i=s(1107),c=s(6913);const h={authorListItem:"authorListItem_n3yI"};var g=s(4848);function p(t){let{author:e}=t;return(0,g.jsx)("li",{className:h.authorListItem,children:(0,g.jsx)(c.A,{as:"h2",author:e,count:e.count})})}function d(t){let{authors:e}=t;return(0,g.jsx)("section",{className:(0,a.A)("margin-vert--lg",h.authorsListSection),children:(0,g.jsx)("ul",{children:e.map((t=>(0,g.jsx)(p,{author:t},t.key)))})})}function m(t){let{authors:e,sidebar:s}=t;const c=(0,l.uz)();return(0,g.jsxs)(o.e3,{className:(0,a.A)(r.G.wrapper.blogPages,r.G.page.blogAuthorsListPage),children:[(0,g.jsx)(o.be,{title:c}),(0,g.jsx)(n.A,{tag:"blog_authors_list"}),(0,g.jsxs)(u.A,{sidebar:s,children:[(0,g.jsx)(i.A,{as:"h1",children:c}),(0,g.jsx)(d,{authors:e})]})]})}},6461:(t,e,s)=>{s.d(e,{ZD:()=>l,uz:()=>u});s(6540);var a=s(1312),o=s(5846);s(4848);function r(){const{selectMessage:t}=(0,o.W)();return e=>t(e,(0,a.T)({id:"theme.blog.post.plurals",description:'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One post|{count} posts"},{count:e}))}function l(t){const e=r();return(0,a.T)({id:"theme.blog.tagTitle",description:"The title of the page for a blog tag",message:'{nPosts} tagged with "{tagName}"'},{nPosts:e(t.count),tagName:t.label})}const u=()=>(0,a.T)({id:"theme.blog.authorsList.pageTitle",message:"Authors",description:"The title of the authors page"})}}]); \ No newline at end of file diff --git a/assets/js/64bd8bad.53e0b372.js b/assets/js/64bd8bad.53e0b372.js new file mode 100644 index 0000000000..26d00b6bcd --- /dev/null +++ b/assets/js/64bd8bad.53e0b372.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1642],{8807:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(4848),t=r(8453);const i={},d="Interface: GroupMetadata",o={id:"reference/api/model/group-metadata/interfaces/GroupMetadata",title:"Interface: GroupMetadata",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent"},next:{title:"Interface: NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"creation",id:"creation",level:3},{value:"defaultSubgroup",id:"defaultsubgroup",level:3},{value:"desc?",id:"desc",level:3},{value:"descOwner?",id:"descowner",level:3},{value:"groupType",id:"grouptype",level:3},{value:"id",id:"id",level:3},{value:"isParentGroup?",id:"isparentgroup",level:3},{value:"isParentGroupClosed",id:"isparentgroupclosed",level:3},{value:"joinedSubgroups",id:"joinedsubgroups",level:3},{value:"owner",id:"owner",level:3},{value:"participants",id:"participants",level:3},{value:"pendingParticipants",id:"pendingparticipants",level:3},{value:"support?",id:"support",level:3},{value:"suspended?",id:"suspended",level:3},{value:"trusted?",id:"trusted",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-groupmetadata",children:"Interface: GroupMetadata"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"creation",children:"creation"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"creation"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The timestamp of when the group was created"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultsubgroup",children:"defaultSubgroup"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"defaultSubgroup"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Communities have a default group chat"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"desc",children:"desc?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"desc"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The description of the group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"descowner",children:"descOwner?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"descOwner"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,s.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The account that set the description last."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"grouptype",children:"groupType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"groupType"}),": ",(0,s.jsx)(n.code,{children:'"DEAFULT"'})," | ",(0,s.jsx)(n.code,{children:'"SUBGROUP"'})," | ",(0,s.jsx)(n.code,{children:'"COMMUNITY"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The type of group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,s.jsx)(n.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The chat id of the group [[GroupChatId]]"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isparentgroup",children:"isParentGroup?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"isParentGroup"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Is this group a parent group (a.k.a community)"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isparentgroupclosed",children:"isParentGroupClosed"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isParentGroupClosed"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"joinedsubgroups",children:"joinedSubgroups"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"joinedSubgroups"}),": `${number}@g.us`[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of Group IDs that the host account has joined as part of this community"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"owner",children:"owner"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"owner"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:(0,s.jsx)(n.code,{children:"NonSerializedId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The id of the owner of the group [[ContactId]]"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"participants",children:"participants"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"participants"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:(0,s.jsx)(n.code,{children:"Participant"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An array of participants in the group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pendingparticipants",children:"pendingParticipants"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pendingParticipants"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:(0,s.jsx)(n.code,{children:"Participant"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unknown."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"support",children:"support?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"support"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Not sure what this represents"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"suspended",children:"suspended?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"suspended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Not sure what this represents"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"trusted",children:"trusted?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"trusted"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>o});var s=r(6540);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/64bd8bad.9339fe2e.js b/assets/js/64bd8bad.9339fe2e.js deleted file mode 100644 index 3640bb03c3..0000000000 --- a/assets/js/64bd8bad.9339fe2e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1642],{8807:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(4848),t=r(8453);const i={},o="Interface: GroupMetadata",d={id:"reference/api/model/group-metadata/interfaces/GroupMetadata",title:"Interface: GroupMetadata",description:"Properties",source:"@site/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GenericGroupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent"},next:{title:"Interface: NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"creation",id:"creation",level:3},{value:"defaultSubgroup",id:"defaultsubgroup",level:3},{value:"desc?",id:"desc",level:3},{value:"descOwner?",id:"descowner",level:3},{value:"groupType",id:"grouptype",level:3},{value:"id",id:"id",level:3},{value:"isParentGroup?",id:"isparentgroup",level:3},{value:"isParentGroupClosed",id:"isparentgroupclosed",level:3},{value:"joinedSubgroups",id:"joinedsubgroups",level:3},{value:"owner",id:"owner",level:3},{value:"participants",id:"participants",level:3},{value:"pendingParticipants",id:"pendingparticipants",level:3},{value:"support?",id:"support",level:3},{value:"suspended?",id:"suspended",level:3},{value:"trusted?",id:"trusted",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-groupmetadata",children:"Interface: GroupMetadata"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"creation",children:"creation"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"creation"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The timestamp of when the group was created"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultsubgroup",children:"defaultSubgroup"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"defaultSubgroup"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Communities have a default group chat"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"desc",children:"desc?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"desc"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The description of the group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"descowner",children:"descOwner?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"descOwner"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,s.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The account that set the description last."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"grouptype",children:"groupType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"groupType"}),": ",(0,s.jsx)(n.code,{children:'"DEAFULT"'})," | ",(0,s.jsx)(n.code,{children:'"SUBGROUP"'})," | ",(0,s.jsx)(n.code,{children:'"COMMUNITY"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The type of group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,s.jsx)(n.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The chat id of the group [[GroupChatId]]"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isparentgroup",children:"isParentGroup?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"isParentGroup"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Is this group a parent group (a.k.a community)"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isparentgroupclosed",children:"isParentGroupClosed"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isParentGroupClosed"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"joinedsubgroups",children:"joinedSubgroups"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"joinedSubgroups"}),": `${number}@g.us`[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of Group IDs that the host account has joined as part of this community"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"owner",children:"owner"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"owner"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:(0,s.jsx)(n.code,{children:"NonSerializedId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The id of the owner of the group [[ContactId]]"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"participants",children:"participants"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"participants"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:(0,s.jsx)(n.code,{children:"Participant"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An array of participants in the group"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pendingparticipants",children:"pendingParticipants"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pendingParticipants"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:(0,s.jsx)(n.code,{children:"Participant"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unknown."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"support",children:"support?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"support"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Not sure what this represents"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"suspended",children:"suspended?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"suspended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Not sure what this represents"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"trusted",children:"trusted?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"trusted"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>d});var s=r(6540);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6679ae86.26e55848.js b/assets/js/6679ae86.26e55848.js new file mode 100644 index 0000000000..40da01e137 --- /dev/null +++ b/assets/js/6679ae86.26e55848.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6647],{743:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=s(4848),n=s(8453);const i={},o="Interface: DialogListMessageRow",c={id:"reference/structures/Dialog/interfaces/DialogListMessageRow",title:"Interface: DialogListMessageRow",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons"},next:{title:"Interface: DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"title",id:"title",level:3},{value:"value",id:"value",level:3}];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-dialoglistmessagerow",children:"Interface: DialogListMessageRow"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"description",children:"description"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"description"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"value",children:"value"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"value"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var r=s(6540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6679ae86.beb0fe5d.js b/assets/js/6679ae86.beb0fe5d.js deleted file mode 100644 index 16594c96d6..0000000000 --- a/assets/js/6679ae86.beb0fe5d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6647],{743:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=s(4848),n=s(8453);const i={},o="Interface: DialogListMessageRow",c={id:"reference/structures/Dialog/interfaces/DialogListMessageRow",title:"Interface: DialogListMessageRow",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons"},next:{title:"Interface: DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"title",id:"title",level:3},{value:"value",id:"value",level:3}];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-dialoglistmessagerow",children:"Interface: DialogListMessageRow"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"description",children:"description"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"description"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"value",children:"value"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"value"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var r=s(6540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6844db42.3a26f550.js b/assets/js/6844db42.3a26f550.js deleted file mode 100644 index d5033a2610..0000000000 --- a/assets/js/6844db42.3a26f550.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7657],{2060:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var s=r(4848),t=r(8453);const o={},a="Error Handling",c={id:"how-to/handle-errors",title:"Error Handling",description:"Keep your promises!",source:"@site/docs/how-to/handle-errors.md",sourceDirName:"how-to",slug:"/how-to/handle-errors",permalink:"/docs/how-to/handle-errors",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/handle-errors.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Group",permalink:"/docs/how-to/groups"},next:{title:"Handle Incoming Call",permalink:"/docs/how-to/incoming-calls"}},i={},l=[{value:"Keep your promises!",id:"keep-your-promises",level:2},{value:"Error handling on create",id:"error-handling-on-create",level:2},{value:"Manage page errors",id:"manage-page-errors",level:2},{value:"Kill the session",id:"kill-the-session",level:2}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"error-handling",children:"Error Handling"}),"\n",(0,s.jsx)(n.h2,{id:"keep-your-promises",children:"Keep your promises!"}),"\n",(0,s.jsxs)(n.p,{children:["Treat all ",(0,s.jsx)(n.code,{children:"client"})," methods as promises. Therefore make sure to await them and wrap them in ",(0,s.jsx)(n.code,{children:"try/catch"})," blocks"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:" client.onMessage(async message => {\n try{\n //respond with 'Hi!'\n await client.sendText(message.from, 'Hi!');\n } catch(error){\n console.log(error);\n }\n })\n\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"error-handling-on-create",children:["Error handling on ",(0,s.jsx)(n.code,{children:"create"})]}),"\n",(0,s.jsx)(n.p,{children:"The [[create]] method itself is a promise so you can handle errors using a try catch block here also from which you can choose to try again or exit the process."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"async function start(client){\n ...\n}\n\nasync function launch(){\n try{\n const client = await create();\n await start(client);\n } catch(error){\n console.log(errror)\n }\n}\n\nlaunch();\n\n"})}),"\n",(0,s.jsx)(n.p,{children:'Alternatively, you can set the client "start" function (the function that consumes the client after it has been created) as a config variable [[restartOnCrash]], allowing the process itself to restart/retry if there are any issues. Be careful with this as it may lead to an endless loop.'}),"\n",(0,s.jsx)(n.p,{children:"You can also use [[logConsole]] (logs all browser console output) or just [[logConsoleErrors]] (only logs browser errors) to better debug issues."}),"\n",(0,s.jsx)(n.p,{children:"Setting [[killProcessOnBrowserClose]] to true will kill the whole node process upon any critical browser issue (maybe the browser runs out of memory and crashes, this option will kill the process)."}),"\n",(0,s.jsxs)(n.p,{children:["This is useful if you have a n orchestrator process that restarts processes. (e.g ",(0,s.jsx)(n.a,{href:"https://pm2.keymetrics.io/",children:"pm2"})," or a ",(0,s.jsx)(n.a,{href:"https://docs.docker.com/config/containers/start-containers-automatically/#:~:text=Restart%20policy%20details,-Keep%20the%20following&text=A%20restart%20policy%20only%20takes,going%20into%20a%20restart%20loop.",children:"docker restart policy"}),")"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"async function start(client){\n ...\n}\n\nasync function launch(){\n try{\n const client = await create({\n //sets restartOnCrash to the above `start` function\n restartOnCrash: start,\n\n //log all browser console output\n logConsole: true,\n\n //or just browser errors\n logConsoleErrors: true,\n\n //kill the process if the browser crashes/is closed manually\n killProcessOnBrowserClose: true\n });\n await start(client);\n } catch(error){\n console.log(error)\n }\n}\n\nlaunch();\n"})}),"\n",(0,s.jsx)(n.h2,{id:"manage-page-errors",children:"Manage page errors"}),"\n",(0,s.jsxs)(n.p,{children:["Since this project is built upon puppeteer, you can access the ",(0,s.jsx)(n.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v2.0.0&show=api-class-page",children:"Puppeteer Page"})," instance by referencing ",(0,s.jsx)(n.code,{children:"client.getPage()"}),", and then therefore you can listen to any errors on the page like so:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"client.getPage().on('error', _=>{\n...\n}\n"})}),"\n",(0,s.jsx)(n.h2,{id:"kill-the-session",children:"Kill the session"}),"\n",(0,s.jsx)(n.p,{children:"As of v1.6.6^ you can now kill the session when required. Best practice is to manage trycatch-es yourself and kill the client on catch."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"try{\n...\nawait client.sendMessage(...\n...\n} catch(error){\nclient.kill();\n//maybe restart the session then\n}\n"})})]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>c});var s=r(6540);const t={},o=s.createContext(t);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6844db42.fd2f680d.js b/assets/js/6844db42.fd2f680d.js new file mode 100644 index 0000000000..bc25e3518e --- /dev/null +++ b/assets/js/6844db42.fd2f680d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7657],{2060:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var s=n(4848),t=n(8453);const o={},a="Error Handling",c={id:"how-to/handle-errors",title:"Error Handling",description:"Keep your promises!",source:"@site/docs/how-to/handle-errors.md",sourceDirName:"how-to",slug:"/how-to/handle-errors",permalink:"/docs/how-to/handle-errors",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/handle-errors.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Group",permalink:"/docs/how-to/groups"},next:{title:"Handle Incoming Call",permalink:"/docs/how-to/incoming-calls"}},i={},l=[{value:"Keep your promises!",id:"keep-your-promises",level:2},{value:"Error handling on create",id:"error-handling-on-create",level:2},{value:"Manage page errors",id:"manage-page-errors",level:2},{value:"Kill the session",id:"kill-the-session",level:2}];function h(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"error-handling",children:"Error Handling"})}),"\n",(0,s.jsx)(r.h2,{id:"keep-your-promises",children:"Keep your promises!"}),"\n",(0,s.jsxs)(r.p,{children:["Treat all ",(0,s.jsx)(r.code,{children:"client"})," methods as promises. Therefore make sure to await them and wrap them in ",(0,s.jsx)(r.code,{children:"try/catch"})," blocks"]}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-javascript",children:" client.onMessage(async message => {\n try{\n //respond with 'Hi!'\n await client.sendText(message.from, 'Hi!');\n } catch(error){\n console.log(error);\n }\n })\n\n"})}),"\n",(0,s.jsxs)(r.h2,{id:"error-handling-on-create",children:["Error handling on ",(0,s.jsx)(r.code,{children:"create"})]}),"\n",(0,s.jsx)(r.p,{children:"The [[create]] method itself is a promise so you can handle errors using a try catch block here also from which you can choose to try again or exit the process."}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-javascript",children:"async function start(client){\n ...\n}\n\nasync function launch(){\n try{\n const client = await create();\n await start(client);\n } catch(error){\n console.log(errror)\n }\n}\n\nlaunch();\n\n"})}),"\n",(0,s.jsx)(r.p,{children:'Alternatively, you can set the client "start" function (the function that consumes the client after it has been created) as a config variable [[restartOnCrash]], allowing the process itself to restart/retry if there are any issues. Be careful with this as it may lead to an endless loop.'}),"\n",(0,s.jsx)(r.p,{children:"You can also use [[logConsole]] (logs all browser console output) or just [[logConsoleErrors]] (only logs browser errors) to better debug issues."}),"\n",(0,s.jsx)(r.p,{children:"Setting [[killProcessOnBrowserClose]] to true will kill the whole node process upon any critical browser issue (maybe the browser runs out of memory and crashes, this option will kill the process)."}),"\n",(0,s.jsxs)(r.p,{children:["This is useful if you have a n orchestrator process that restarts processes. (e.g ",(0,s.jsx)(r.a,{href:"https://pm2.keymetrics.io/",children:"pm2"})," or a ",(0,s.jsx)(r.a,{href:"https://docs.docker.com/config/containers/start-containers-automatically/#:~:text=Restart%20policy%20details,-Keep%20the%20following&text=A%20restart%20policy%20only%20takes,going%20into%20a%20restart%20loop.",children:"docker restart policy"}),")"]}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-javascript",children:"async function start(client){\n ...\n}\n\nasync function launch(){\n try{\n const client = await create({\n //sets restartOnCrash to the above `start` function\n restartOnCrash: start,\n\n //log all browser console output\n logConsole: true,\n\n //or just browser errors\n logConsoleErrors: true,\n\n //kill the process if the browser crashes/is closed manually\n killProcessOnBrowserClose: true\n });\n await start(client);\n } catch(error){\n console.log(error)\n }\n}\n\nlaunch();\n"})}),"\n",(0,s.jsx)(r.h2,{id:"manage-page-errors",children:"Manage page errors"}),"\n",(0,s.jsxs)(r.p,{children:["Since this project is built upon puppeteer, you can access the ",(0,s.jsx)(r.a,{href:"https://pptr.dev/#?product=Puppeteer&version=v2.0.0&show=api-class-page",children:"Puppeteer Page"})," instance by referencing ",(0,s.jsx)(r.code,{children:"client.getPage()"}),", and then therefore you can listen to any errors on the page like so:"]}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-javascript",children:"client.getPage().on('error', _=>{\n...\n}\n"})}),"\n",(0,s.jsx)(r.h2,{id:"kill-the-session",children:"Kill the session"}),"\n",(0,s.jsx)(r.p,{children:"As of v1.6.6^ you can now kill the session when required. Best practice is to manage trycatch-es yourself and kill the client on catch."}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-javascript",children:"try{\n...\nawait client.sendMessage(...\n...\n} catch(error){\nclient.kill();\n//maybe restart the session then\n}\n"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>a,x:()=>c});var s=n(6540);const t={},o=s.createContext(t);function a(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6875c492.a128b6b9.js b/assets/js/6875c492.a128b6b9.js new file mode 100644 index 0000000000..9c987803db --- /dev/null +++ b/assets/js/6875c492.a128b6b9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4813],{7713:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var a=n(1312),s=n(9022),i=n(4848);function r(e){const{metadata:t}=e,{previousPage:n,nextPage:r}=t;return(0,i.jsxs)("nav",{className:"pagination-nav","aria-label":(0,a.T)({id:"theme.blog.paginator.navAriaLabel",message:"Blog list page navigation",description:"The ARIA label for the blog pagination"}),children:[n&&(0,i.jsx)(s.A,{permalink:n,title:(0,i.jsx)(a.A,{id:"theme.blog.paginator.newerEntries",description:"The label used to navigate to the newer blog posts page (previous page)",children:"Newer entries"})}),r&&(0,i.jsx)(s.A,{permalink:r,title:(0,i.jsx)(a.A,{id:"theme.blog.paginator.olderEntries",description:"The label used to navigate to the older blog posts page (next page)",children:"Older entries"}),isNext:!0})]})}},2907:(e,t,n)=>{n.d(t,{A:()=>B});n(6540);var a=n(4164),s=n(4096),i=n(4848);function r(e){let{children:t,className:n}=e;return(0,i.jsx)("article",{className:n,children:t})}var l=n(8774);const o={title:"title_f1Hy"};function c(e){let{className:t}=e;const{metadata:n,isBlogPostPage:r}=(0,s.e7)(),{permalink:c,title:d}=n,g=r?"h1":"h2";return(0,i.jsx)(g,{className:(0,a.A)(o.title,t),children:r?d:(0,i.jsx)(l.A,{to:c,children:d})})}var d=n(1312),g=n(5846),u=n(6266);const m={container:"container_mt6G"};function h(e){let{readingTime:t}=e;const n=function(){const{selectMessage:e}=(0,g.W)();return t=>{const n=Math.ceil(t);return e(n,(0,d.T)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:n}))}}();return(0,i.jsx)(i.Fragment,{children:n(t)})}function p(e){let{date:t,formattedDate:n}=e;return(0,i.jsx)("time",{dateTime:t,children:n})}function x(){return(0,i.jsx)(i.Fragment,{children:" \xb7 "})}function j(e){let{className:t}=e;const{metadata:n}=(0,s.e7)(),{date:r,readingTime:l}=n,o=(0,u.i)({day:"numeric",month:"long",year:"numeric",timeZone:"UTC"});return(0,i.jsxs)("div",{className:(0,a.A)(m.container,"margin-vert--md",t),children:[(0,i.jsx)(p,{date:r,formattedDate:(c=r,o.format(new Date(c)))}),void 0!==l&&(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x,{}),(0,i.jsx)(h,{readingTime:l})]})]});var c}var A=n(6913);const b={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function f(e){let{className:t}=e;const{metadata:{authors:n},assets:r}=(0,s.e7)();if(0===n.length)return null;const l=n.every((e=>{let{name:t}=e;return!t})),o=1===n.length;return(0,i.jsx)("div",{className:(0,a.A)("margin-top--md margin-bottom--sm",l?b.imageOnlyAuthorRow:"row",t),children:n.map(((e,t)=>(0,i.jsx)("div",{className:(0,a.A)(!l&&(o?"col col--12":"col col--6"),l?b.imageOnlyAuthorCol:b.authorCol),children:(0,i.jsx)(A.A,{author:{...e,imageURL:r.authorsImageUrls[t]??e.imageURL}})},t)))})}function v(){return(0,i.jsxs)("header",{children:[(0,i.jsx)(c,{}),(0,i.jsx)(j,{}),(0,i.jsx)(f,{})]})}var T=n(440),N=n(8509);function w(e){let{children:t,className:n}=e;const{isBlogPostPage:r}=(0,s.e7)();return(0,i.jsx)("div",{id:r?T.LU:void 0,className:(0,a.A)("markdown",n),children:(0,i.jsx)(N.A,{children:t})})}var _=n(7559),y=n(4336),k=n(2053);function P(){return(0,i.jsx)("b",{children:(0,i.jsx)(d.A,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts",children:"Read more"})})}function R(e){const{blogPostTitle:t,...n}=e;return(0,i.jsx)(l.A,{"aria-label":(0,d.T)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t}),...n,children:(0,i.jsx)(P,{})})}function U(){const{metadata:e,isBlogPostPage:t}=(0,s.e7)(),{tags:n,title:r,editUrl:l,hasTruncateMarker:o,lastUpdatedBy:c,lastUpdatedAt:d}=e,g=!t&&o,u=n.length>0;if(!(u||g||l))return null;if(t){const e=!!(l||d||c);return(0,i.jsxs)("footer",{className:"docusaurus-mt-lg",children:[u&&(0,i.jsx)("div",{className:(0,a.A)("row","margin-top--sm",_.G.blog.blogFooterEditMetaRow),children:(0,i.jsx)("div",{className:"col",children:(0,i.jsx)(k.A,{tags:n})})}),e&&(0,i.jsx)(y.A,{className:(0,a.A)("margin-top--sm",_.G.blog.blogFooterEditMetaRow),editUrl:l,lastUpdatedAt:d,lastUpdatedBy:c})]})}return(0,i.jsxs)("footer",{className:"row docusaurus-mt-lg",children:[u&&(0,i.jsx)("div",{className:(0,a.A)("col",{"col--9":g}),children:(0,i.jsx)(k.A,{tags:n})}),g&&(0,i.jsx)("div",{className:(0,a.A)("col text--right",{"col--3":u}),children:(0,i.jsx)(R,{blogPostTitle:r,to:e.permalink})})]})}function B(e){let{children:t,className:n}=e;const l=function(){const{isBlogPostPage:e}=(0,s.e7)();return e?void 0:"margin-bottom--xl"}();return(0,i.jsxs)(r,{className:(0,a.A)(l,n),children:[(0,i.jsx)(v,{}),(0,i.jsx)(w,{children:t}),(0,i.jsx)(U,{})]})}},3892:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var a=n(4096),s=n(2907),i=n(4848);function r(e){let{items:t,component:n=s.A}=e;return(0,i.jsx)(i.Fragment,{children:t.map((e=>{let{content:t}=e;return(0,i.jsx)(a.in,{content:t,children:(0,i.jsx)(n,{children:(0,i.jsx)(t,{})})},t.metadata.permalink)}))})}},3069:(e,t,n)=>{n.r(t),n.d(t,{default:()=>A});n(6540);var a=n(4164),s=n(1312),i=n(5500),r=n(7559),l=n(6461),o=n(8774),c=n(8027),d=n(7713),g=n(1463),u=n(3892),m=n(2234),h=n(1107),p=n(4848);function x(e){let{tag:t}=e;const n=(0,l.ZD)(t);return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(i.be,{title:n,description:t.description}),(0,p.jsx)(g.A,{tag:"blog_tags_posts"})]})}function j(e){let{tag:t,items:n,sidebar:a,listMetadata:i}=e;const r=(0,l.ZD)(t);return(0,p.jsxs)(c.A,{sidebar:a,children:[t.unlisted&&(0,p.jsx)(m.A,{}),(0,p.jsxs)("header",{className:"margin-bottom--xl",children:[(0,p.jsx)(h.A,{as:"h1",children:r}),t.description&&(0,p.jsx)("p",{children:t.description}),(0,p.jsx)(o.A,{href:t.allTagsPath,children:(0,p.jsx)(s.A,{id:"theme.tags.tagsPageLink",description:"The label of the link targeting the tag list page",children:"View All Tags"})})]}),(0,p.jsx)(u.A,{items:n}),(0,p.jsx)(d.A,{metadata:i})]})}function A(e){return(0,p.jsxs)(i.e3,{className:(0,a.A)(r.G.wrapper.blogPages,r.G.page.blogTagPostListPage),children:[(0,p.jsx)(x,{...e}),(0,p.jsx)(j,{...e})]})}},2234:(e,t,n)=>{n.d(t,{A:()=>c});n(6540);var a=n(4164),s=n(4084),i=n(7559),r=n(890),l=n(4848);function o(e){let{className:t}=e;return(0,l.jsx)(r.A,{type:"caution",title:(0,l.jsx)(s.Rc,{}),className:(0,a.A)(t,i.G.common.unlistedBanner),children:(0,l.jsx)(s.Uh,{})})}function c(e){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.AE,{}),(0,l.jsx)(o,{...e})]})}},9022:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var a=n(4164),s=n(8774),i=n(4848);function r(e){const{permalink:t,title:n,subLabel:r,isNext:l}=e;return(0,i.jsxs)(s.A,{className:(0,a.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[r&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:r}),(0,i.jsx)("div",{className:"pagination-nav__label",children:n})]})}},6133:(e,t,n)=>{n.d(t,{A:()=>l});n(6540);var a=n(4164),s=n(8774);const i={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var r=n(4848);function l(e){let{permalink:t,label:n,count:l,description:o}=e;return(0,r.jsxs)(s.A,{href:t,title:o,className:(0,a.A)(i.tag,l?i.tagWithCount:i.tagRegular),children:[n,l&&(0,r.jsx)("span",{children:l})]})}},2053:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var a=n(4164),s=n(1312),i=n(6133);const r={tags:"tags_jXut",tag:"tag_QGVx"};var l=n(4848);function o(e){let{tags:t}=e;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("b",{children:(0,l.jsx)(s.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,l.jsx)("ul",{className:(0,a.A)(r.tags,"padding--none","margin-left--sm"),children:t.map((e=>(0,l.jsx)("li",{className:r.tag,children:(0,l.jsx)(i.A,{...e})},e.permalink)))})]})}},6461:(e,t,n)=>{n.d(t,{ZD:()=>r,uz:()=>l});n(6540);var a=n(1312),s=n(5846);n(4848);function i(){const{selectMessage:e}=(0,s.W)();return t=>e(t,(0,a.T)({id:"theme.blog.post.plurals",description:'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One post|{count} posts"},{count:t}))}function r(e){const t=i();return(0,a.T)({id:"theme.blog.tagTitle",description:"The title of the page for a blog tag",message:'{nPosts} tagged with "{tagName}"'},{nPosts:t(e.count),tagName:e.label})}const l=()=>(0,a.T)({id:"theme.blog.authorsList.pageTitle",message:"Authors",description:"The title of the authors page"})},4084:(e,t,n)=>{n.d(t,{AE:()=>o,Rc:()=>r,TT:()=>d,Uh:()=>l,Yh:()=>c});n(6540);var a=n(1312),s=n(5260),i=n(4848);function r(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function l(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function o(){return(0,i.jsx)(s.A,{children:(0,i.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function c(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function d(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}},4037:(e,t,n)=>{n.d(t,{A:()=>s});n(6540);var a=n(3028);n(4848);const s={...a.A,license:a.A.note}},890:(e,t,n)=>{n.d(t,{A:()=>i});n(6540);var a=n(4741),s=n(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,s.jsx)(a.A,{icon:"\ud83c\udfc5",...e}):(0,s.jsx)(s.Fragment,{children:(0,s.jsx)(a.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/6875c492.cd36c0c2.js b/assets/js/6875c492.cd36c0c2.js deleted file mode 100644 index d7a6eaa9f9..0000000000 --- a/assets/js/6875c492.cd36c0c2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4813],{7713:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var s=n(1312),a=n(9022),i=n(4848);function r(e){const{metadata:t}=e,{previousPage:n,nextPage:r}=t;return(0,i.jsxs)("nav",{className:"pagination-nav","aria-label":(0,s.T)({id:"theme.blog.paginator.navAriaLabel",message:"Blog list page navigation",description:"The ARIA label for the blog pagination"}),children:[n&&(0,i.jsx)(a.A,{permalink:n,title:(0,i.jsx)(s.A,{id:"theme.blog.paginator.newerEntries",description:"The label used to navigate to the newer blog posts page (previous page)",children:"Newer Entries"})}),r&&(0,i.jsx)(a.A,{permalink:r,title:(0,i.jsx)(s.A,{id:"theme.blog.paginator.olderEntries",description:"The label used to navigate to the older blog posts page (next page)",children:"Older Entries"}),isNext:!0})]})}},3892:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var s=n(7131),a=n(4651),i=n(4848);function r(e){let{items:t,component:n=a.A}=e;return(0,i.jsx)(i.Fragment,{children:t.map((e=>{let{content:t}=e;return(0,i.jsx)(s.i,{content:t,children:(0,i.jsx)(n,{children:(0,i.jsx)(t,{})})},t.metadata.permalink)}))})}},3069:(e,t,n)=>{n.r(t),n.d(t,{default:()=>b});n(6540);var s=n(4164),a=n(1312),i=n(5846),r=n(5500),l=n(7559),o=n(8774),c=n(6535),d=n(7713),g=n(1463),p=n(3892),u=n(996),h=n(1107),m=n(4848);function x(e){const t=function(){const{selectMessage:e}=(0,i.W)();return t=>e(t,(0,a.T)({id:"theme.blog.post.plurals",description:'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One post|{count} posts"},{count:t}))}();return(0,a.T)({id:"theme.blog.tagTitle",description:"The title of the page for a blog tag",message:'{nPosts} tagged with "{tagName}"'},{nPosts:t(e.count),tagName:e.label})}function j(e){let{tag:t}=e;const n=x(t);return(0,m.jsxs)(m.Fragment,{children:[(0,m.jsx)(r.be,{title:n,description:t.description}),(0,m.jsx)(g.A,{tag:"blog_tags_posts"})]})}function A(e){let{tag:t,items:n,sidebar:s,listMetadata:i}=e;const r=x(t);return(0,m.jsxs)(c.A,{sidebar:s,children:[t.unlisted&&(0,m.jsx)(u.A,{}),(0,m.jsxs)("header",{className:"margin-bottom--xl",children:[(0,m.jsx)(h.A,{as:"h1",children:r}),t.description&&(0,m.jsx)("p",{children:t.description}),(0,m.jsx)(o.A,{href:t.allTagsPath,children:(0,m.jsx)(a.A,{id:"theme.tags.tagsPageLink",description:"The label of the link targeting the tag list page",children:"View All Tags"})})]}),(0,m.jsx)(p.A,{items:n}),(0,m.jsx)(d.A,{metadata:i})]})}function b(e){return(0,m.jsxs)(r.e3,{className:(0,s.A)(l.G.wrapper.blogPages,l.G.page.blogTagPostListPage),children:[(0,m.jsx)(j,{...e}),(0,m.jsx)(A,{...e})]})}},996:(e,t,n)=>{n.d(t,{A:()=>u});n(6540);var s=n(4164),a=n(1312),i=n(5260),r=n(4848);function l(){return(0,r.jsx)(a.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function o(){return(0,r.jsx)(a.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function c(){return(0,r.jsx)(i.A,{children:(0,r.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}var d=n(7559),g=n(890);function p(e){let{className:t}=e;return(0,r.jsx)(g.A,{type:"caution",title:(0,r.jsx)(l,{}),className:(0,s.A)(t,d.G.common.unlistedBanner),children:(0,r.jsx)(o,{})})}function u(e){return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(c,{}),(0,r.jsx)(p,{...e})]})}},4037:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(3028);n(4848);const a={...s.A,license:s.A.note}},890:(e,t,n)=>{n.d(t,{A:()=>i});n(6540);var s=n(4741),a=n(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,a.jsx)(s.A,{icon:"\ud83c\udfc5",...e}):(0,a.jsx)(a.Fragment,{children:(0,a.jsx)(s.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/6922041d.200c1246.js b/assets/js/6922041d.200c1246.js deleted file mode 100644 index ace22dfb9a..0000000000 --- a/assets/js/6922041d.200c1246.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7807],{6453:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>r,default:()=>d,frontMatter:()=>c,metadata:()=>o,toc:()=>u});var s=n(4848),a=n(8453);const c={},r="Type Alias: AccountNumber",o={id:"reference/api/model/aliases/type-aliases/AccountNumber",title:"Type Alias: AccountNumber",description:"AccountNumber: \\$\\{number\\}\\",source:"@site/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"},next:{title:"Type Alias: AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile"}},i={},u=[];function l(e){const t={blockquote:"blockquote",h1:"h1",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-accountnumber",children:"Type Alias: AccountNumber"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"AccountNumber"}),": `${number}`"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The account number. It is made up of a country code and then the local number without the preceeding 0. For example, if a UK (+44) wa account is linked to the number 07123456789 then the account number will be 447123456789."})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var s=n(6540);const a={},c=s.createContext(a);function r(e){const t=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6922041d.56e82e81.js b/assets/js/6922041d.56e82e81.js new file mode 100644 index 0000000000..e13b0def8b --- /dev/null +++ b/assets/js/6922041d.56e82e81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7807],{6453:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var s=n(4848),a=n(8453);const r={},c="Type Alias: AccountNumber",o={id:"reference/api/model/aliases/type-aliases/AccountNumber",title:"Type Alias: AccountNumber",description:"AccountNumber: \\$\\{number\\}\\",source:"@site/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"},next:{title:"Type Alias: AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile"}},i={},u=[];function l(e){const t={blockquote:"blockquote",h1:"h1",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"type-alias-accountnumber",children:"Type Alias: AccountNumber"})}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"AccountNumber"}),": `${number}`"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The account number. It is made up of a country code and then the local number without the preceeding 0. For example, if a UK (+44) wa account is linked to the number 07123456789 then the account number will be 447123456789."})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var s=n(6540);const a={},r=s.createContext(a);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6afe94c3.8f2cd245.js b/assets/js/6afe94c3.8f2cd245.js new file mode 100644 index 0000000000..dbb9026641 --- /dev/null +++ b/assets/js/6afe94c3.8f2cd245.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6290],{492:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var r=t(4848),o=t(8453);const c={},s="Interface: AdvancedButton",d={id:"reference/api/model/button/interfaces/AdvancedButton",title:"Interface: AdvancedButton",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/AdvancedButton.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/AdvancedButton.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/button",permalink:"/docs/reference/api/model/button/"},next:{title:"Interface: Button",permalink:"/docs/reference/api/model/button/interfaces/Button"}},i={},l=[{value:"Properties",id:"properties",level:2},{value:"id?",id:"id",level:3},{value:"number?",id:"number",level:3},{value:"text",id:"text",level:3},{value:"url?",id:"url",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-advancedbutton",children:"Interface: AdvancedButton"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"number",children:"number?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"number"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"text",children:"text"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"text"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"url",children:"url?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"url"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var r=t(6540);const o={},c=r.createContext(o);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6afe94c3.905af7c5.js b/assets/js/6afe94c3.905af7c5.js deleted file mode 100644 index 6446752ec0..0000000000 --- a/assets/js/6afe94c3.905af7c5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6290],{492:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var r=t(4848),o=t(8453);const c={},s="Interface: AdvancedButton",d={id:"reference/api/model/button/interfaces/AdvancedButton",title:"Interface: AdvancedButton",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/AdvancedButton.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/AdvancedButton.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/button",permalink:"/docs/reference/api/model/button/"},next:{title:"Interface: Button",permalink:"/docs/reference/api/model/button/interfaces/Button"}},i={},l=[{value:"Properties",id:"properties",level:2},{value:"id?",id:"id",level:3},{value:"number?",id:"number",level:3},{value:"text",id:"text",level:3},{value:"url?",id:"url",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-advancedbutton",children:"Interface: AdvancedButton"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"number",children:"number?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"number"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"text",children:"text"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"text"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"url",children:"url?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"url"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var r=t(6540);const o={},c=r.createContext(o);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6b55e007.5b51ac19.js b/assets/js/6b55e007.5b51ac19.js deleted file mode 100644 index 6fbf62650e..0000000000 --- a/assets/js/6b55e007.5b51ac19.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8773],{6722:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var o=t(4848),i=t(8453);const s={sidebar_label:"The Config Object",description:"Guide showing how to edit the settings.",sidebar_position:0},a="Configuration",r={id:"configuration/config-object",title:"Configuration",description:"Guide showing how to edit the settings.",source:"@site/docs/configuration/config-object.md",sourceDirName:"configuration",slug:"/configuration/config-object",permalink:"/docs/configuration/config-object",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/config-object.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_label:"The Config Object",description:"Guide showing how to edit the settings.",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Socket mode",permalink:"/docs/get-started/socketmode"},next:{title:"EASY API CLI options",permalink:"/docs/configuration/command-line-options"}},c={},d=[{value:"Timing out an unpaired session",id:"timing-out-an-unpaired-session",level:2},{value:"Emitting a limited amount of qr codes",id:"emitting-a-limited-amount-of-qr-codes",level:2},{value:"Open with browser",id:"open-with-browser",level:2}];function l(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"configuration",children:"Configuration"}),"\n",(0,o.jsx)(n.p,{children:"There are quite a few ways you can customize your session."}),"\n",(0,o.jsxs)(n.p,{children:["Find out about all possible options here: ",(0,o.jsx)(n.a,{href:"/docs/api/interfaces/api_model_config.ConfigObject",children:"api.ConfigObject"})]}),"\n",(0,o.jsx)(n.p,{children:"Set the desired config options as parameter on [create]."}),"\n",(0,o.jsx)(n.p,{children:"In the following example:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"The process tries to find and run a chrome installation instead of using the default chromium (chrome is required to send videos & GIFS) [ConfigObject.useChrome]"}),"\n",(0,o.jsx)(n.li,{children:"Automatically refreshes the QR code at regular intervals [ConfigObject.autoRefresh]"}),"\n",(0,o.jsx)(n.li,{children:"Disables the cache (may be useful to optimize memory consumption) [ConfigObject.cacheEnabled]"}),"\n",(0,o.jsxs)(n.li,{children:["Sets the session Id to ",(0,o.jsx)(n.code,{children:"hr"})," (this will result in a file called ",(0,o.jsx)(n.code,{children:"hr.data.json"})," being saved to the process working directory) [ConfigObject.sessionId]"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"const { create, Client } = require('@open-wa/wa-automate');\n// or\n// import { create, Client } from '@open-wa/wa-automate';\n\nconst launchConfig = {\n useChrome: true,\n autoRefresh:true,\n cacheEnabled:false,\n sessionId: 'hr'\n};\n\nfunction start(client) {\n client.onMessage(async message => {\n if (message.body === 'Hi') {\n await client.sendText(message.from, '\ud83d\udc4b Hello!');\n }\n });\n}\n\ncreate(launchConfig).then(start);\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"timing-out-an-unpaired-session",children:"Timing out an unpaired session"}),"\n",(0,o.jsx)(n.p,{children:"If you want to kill the process after a certain amount of seconds due to an unscanned code, you can now set the qrTimeout parameter in the configuration object. You can also use authTimeout if you want to wait only a certain period of time to wait for the session to connect to the phone."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n qrTimeout: 30, //kills the session if the QR code is not scanned within 30 seconds.\n authTimeout: 30 //kills the session if the session hasn't authentication 30 seconds (e.g If the session has the right credentials but the phone is off).\n})\n.then(client => start(client));\n"})}),"\n",(0,o.jsx)(n.h2,{id:"emitting-a-limited-amount-of-qr-codes",children:"Emitting a limited amount of qr codes"}),"\n",(0,o.jsx)(n.p,{children:"Set [ConfigObject.maxQr] to limit the amount of QR codes to show before closing the process."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n maxQr:10,\n}).then(async client => await start(client));\n"})}),"\n",(0,o.jsx)(n.h2,{id:"open-with-browser",children:"Open with browser"}),"\n",(0,o.jsxs)(n.p,{children:["The actual browser window you use is called a ",(0,o.jsx)(n.code,{children:"head"}),", by default the library runs a chrome session ",(0,o.jsx)(n.em,{children:(0,o.jsx)(n.strong,{children:"headless"})})," (i.e in the background - you don't see it). If you want the browser to open up to see what's going on you can set ",(0,o.jsx)(n.code,{children:"ConfigObject.headless"})," to ",(0,o.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n headless: false\n}).then(async client => await start(client));\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var o=t(6540);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6b55e007.d0dcbeeb.js b/assets/js/6b55e007.d0dcbeeb.js new file mode 100644 index 0000000000..6993b72e48 --- /dev/null +++ b/assets/js/6b55e007.d0dcbeeb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8773],{6722:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var o=t(4848),i=t(8453);const s={sidebar_label:"The Config Object",description:"Guide showing how to edit the settings.",sidebar_position:0},a="Configuration",r={id:"configuration/config-object",title:"Configuration",description:"Guide showing how to edit the settings.",source:"@site/docs/configuration/config-object.md",sourceDirName:"configuration",slug:"/configuration/config-object",permalink:"/docs/configuration/config-object",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/config-object.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_label:"The Config Object",description:"Guide showing how to edit the settings.",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Socket mode",permalink:"/docs/get-started/socketmode"},next:{title:"EASY API CLI options",permalink:"/docs/configuration/command-line-options"}},c={},d=[{value:"Timing out an unpaired session",id:"timing-out-an-unpaired-session",level:2},{value:"Emitting a limited amount of qr codes",id:"emitting-a-limited-amount-of-qr-codes",level:2},{value:"Open with browser",id:"open-with-browser",level:2}];function l(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"configuration",children:"Configuration"})}),"\n",(0,o.jsx)(n.p,{children:"There are quite a few ways you can customize your session."}),"\n",(0,o.jsxs)(n.p,{children:["Find out about all possible options here: ",(0,o.jsx)(n.a,{href:"/docs/api/interfaces/api_model_config.ConfigObject",children:"api.ConfigObject"})]}),"\n",(0,o.jsx)(n.p,{children:"Set the desired config options as parameter on [create]."}),"\n",(0,o.jsx)(n.p,{children:"In the following example:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"The process tries to find and run a chrome installation instead of using the default chromium (chrome is required to send videos & GIFS) [ConfigObject.useChrome]"}),"\n",(0,o.jsx)(n.li,{children:"Automatically refreshes the QR code at regular intervals [ConfigObject.autoRefresh]"}),"\n",(0,o.jsx)(n.li,{children:"Disables the cache (may be useful to optimize memory consumption) [ConfigObject.cacheEnabled]"}),"\n",(0,o.jsxs)(n.li,{children:["Sets the session Id to ",(0,o.jsx)(n.code,{children:"hr"})," (this will result in a file called ",(0,o.jsx)(n.code,{children:"hr.data.json"})," being saved to the process working directory) [ConfigObject.sessionId]"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"const { create, Client } = require('@open-wa/wa-automate');\n// or\n// import { create, Client } from '@open-wa/wa-automate';\n\nconst launchConfig = {\n useChrome: true,\n autoRefresh:true,\n cacheEnabled:false,\n sessionId: 'hr'\n};\n\nfunction start(client) {\n client.onMessage(async message => {\n if (message.body === 'Hi') {\n await client.sendText(message.from, '\ud83d\udc4b Hello!');\n }\n });\n}\n\ncreate(launchConfig).then(start);\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"timing-out-an-unpaired-session",children:"Timing out an unpaired session"}),"\n",(0,o.jsx)(n.p,{children:"If you want to kill the process after a certain amount of seconds due to an unscanned code, you can now set the qrTimeout parameter in the configuration object. You can also use authTimeout if you want to wait only a certain period of time to wait for the session to connect to the phone."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n qrTimeout: 30, //kills the session if the QR code is not scanned within 30 seconds.\n authTimeout: 30 //kills the session if the session hasn't authentication 30 seconds (e.g If the session has the right credentials but the phone is off).\n})\n.then(client => start(client));\n"})}),"\n",(0,o.jsx)(n.h2,{id:"emitting-a-limited-amount-of-qr-codes",children:"Emitting a limited amount of qr codes"}),"\n",(0,o.jsx)(n.p,{children:"Set [ConfigObject.maxQr] to limit the amount of QR codes to show before closing the process."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n maxQr:10,\n}).then(async client => await start(client));\n"})}),"\n",(0,o.jsx)(n.h2,{id:"open-with-browser",children:"Open with browser"}),"\n",(0,o.jsxs)(n.p,{children:["The actual browser window you use is called a ",(0,o.jsx)(n.code,{children:"head"}),", by default the library runs a chrome session ",(0,o.jsx)(n.em,{children:(0,o.jsx)(n.strong,{children:"headless"})})," (i.e in the background - you don't see it). If you want the browser to open up to see what's going on you can set ",(0,o.jsx)(n.code,{children:"ConfigObject.headless"})," to ",(0,o.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n headless: false\n}).then(async client => await start(client));\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var o=t(6540);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6b7169bc.50340939.js b/assets/js/6b7169bc.50340939.js deleted file mode 100644 index 01f7018200..0000000000 --- a/assets/js/6b7169bc.50340939.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3809],{9522:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>n,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>u});var o=r(4848),c=r(8453);const t={},n="Variable: MessagePreprocessors",a={id:"reference/structures/preProcessors/variables/MessagePreprocessors",title:"Variable: MessagePreprocessors",description:"const MessagePreprocessors: object",source:"@site/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",sourceDirName:"reference/structures/preProcessors/variables",slug:"/reference/structures/preProcessors/variables/MessagePreprocessors",permalink:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MessagePreProcessor()",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor"}},i={},u=[{value:"Index Signature",id:"index-signature",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"variable-messagepreprocessors",children:"Variable: MessagePreprocessors"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.code,{children:"const"})," ",(0,o.jsx)(s.strong,{children:"MessagePreprocessors"}),": ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"An object that contains all available [[PREPROCESSORS]]."}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.a,{href:"https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts",children:"Check out the processor code here"})}),"\n",(0,o.jsx)(s.h2,{id:"index-signature",children:"Index Signature"}),"\n",(0,o.jsxs)(s.p,{children:["[",(0,o.jsx)(s.code,{children:"processorName"}),": ",(0,o.jsx)(s.code,{children:"string"}),"]: ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})})]})]})}function l(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>a});var o=r(6540);const c={},t=o.createContext(c);function n(e){const s=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:n(e.components),o.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6b7169bc.8db70c62.js b/assets/js/6b7169bc.8db70c62.js new file mode 100644 index 0000000000..f5b7ddc915 --- /dev/null +++ b/assets/js/6b7169bc.8db70c62.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3809],{9522:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>n,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=r(4848),c=r(8453);const t={},n="Variable: MessagePreprocessors",a={id:"reference/structures/preProcessors/variables/MessagePreprocessors",title:"Variable: MessagePreprocessors",description:"const MessagePreprocessors: object",source:"@site/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",sourceDirName:"reference/structures/preProcessors/variables",slug:"/reference/structures/preProcessors/variables/MessagePreprocessors",permalink:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MessagePreProcessor()",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor"}},i={},d=[{value:"Index Signature",id:"index-signature",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"variable-messagepreprocessors",children:"Variable: MessagePreprocessors"})}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.code,{children:"const"})," ",(0,o.jsx)(s.strong,{children:"MessagePreprocessors"}),": ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"An object that contains all available [[PREPROCESSORS]]."}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.a,{href:"https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts",children:"Check out the processor code here"})}),"\n",(0,o.jsx)(s.h2,{id:"index-signature",children:"Index Signature"}),"\n",(0,o.jsxs)(s.p,{children:["[",(0,o.jsx)(s.code,{children:"processorName"}),": ",(0,o.jsx)(s.code,{children:"string"}),"]: ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})})]})]})}function l(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>a});var o=r(6540);const c={},t=o.createContext(c);function n(e){const s=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:n(e.components),o.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6bd61230.51b90e94.js b/assets/js/6bd61230.51b90e94.js deleted file mode 100644 index a183939889..0000000000 --- a/assets/js/6bd61230.51b90e94.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5293],{2483:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var n=r(4848),o=r(8453);const c={},t="Type Alias: MessagePreProcessor()",a={id:"reference/structures/preProcessors/type-aliases/MessagePreProcessor",title:"Type Alias: MessagePreProcessor()",description:"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\",source:"@site/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",sourceDirName:"reference/structures/preProcessors/type-aliases",slug:"/reference/structures/preProcessors/type-aliases/MessagePreProcessor",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType"},next:{title:"Variable: MessagePreprocessors",permalink:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"type-alias-messagepreprocessor",children:"Type Alias: MessagePreProcessor()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"MessagePreProcessor"}),": (",(0,n.jsx)(s.code,{children:"message"}),", ",(0,n.jsx)(s.code,{children:"client"}),"?, ",(0,n.jsx)(s.code,{children:"alreadyProcessed"}),"?, ",(0,n.jsx)(s.code,{children:"source"}),"?) => ",(0,n.jsx)(s.code,{children:"Promise"}),"<",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"A function that takes a message and returns a message."}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"message"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})})]}),"\n",(0,n.jsx)(s.p,{children:"The message to be processed"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"client?"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,n.jsx)(s.code,{children:"Client"})})]}),"\n",(0,n.jsx)(s.p,{children:"The client that received the message"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"alreadyProcessed?"}),": ",(0,n.jsx)(s.code,{children:"boolean"})]}),"\n",(0,n.jsx)(s.p,{children:"Whether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"source?"}),": ",(0,n.jsx)(s.code,{children:'"onMessage"'})," | ",(0,n.jsx)(s.code,{children:'"onAnyMessage"'})]}),"\n",(0,n.jsx)(s.p,{children:"The source of the message. This is useful for knowing if the message is from onMessage or onAnyMessage. Only processing one source will prevent duplicate processing."}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"Promise"}),"<",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})}),">"]})]})}function h(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>t,x:()=>a});var n=r(6540);const o={},c=n.createContext(o);function t(e){const s=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),n.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6bd61230.d3c0ee7b.js b/assets/js/6bd61230.d3c0ee7b.js new file mode 100644 index 0000000000..f7aa0e8deb --- /dev/null +++ b/assets/js/6bd61230.d3c0ee7b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5293],{2483:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var n=r(4848),o=r(8453);const c={},t="Type Alias: MessagePreProcessor()",a={id:"reference/structures/preProcessors/type-aliases/MessagePreProcessor",title:"Type Alias: MessagePreProcessor()",description:"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\",source:"@site/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",sourceDirName:"reference/structures/preProcessors/type-aliases",slug:"/reference/structures/preProcessors/type-aliases/MessagePreProcessor",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType"},next:{title:"Variable: MessagePreprocessors",permalink:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"type-alias-messagepreprocessor",children:"Type Alias: MessagePreProcessor()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"MessagePreProcessor"}),": (",(0,n.jsx)(s.code,{children:"message"}),", ",(0,n.jsx)(s.code,{children:"client"}),"?, ",(0,n.jsx)(s.code,{children:"alreadyProcessed"}),"?, ",(0,n.jsx)(s.code,{children:"source"}),"?) => ",(0,n.jsx)(s.code,{children:"Promise"}),"<",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"A function that takes a message and returns a message."}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"message"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})})]}),"\n",(0,n.jsx)(s.p,{children:"The message to be processed"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"client?"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,n.jsx)(s.code,{children:"Client"})})]}),"\n",(0,n.jsx)(s.p,{children:"The client that received the message"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"alreadyProcessed?"}),": ",(0,n.jsx)(s.code,{children:"boolean"})]}),"\n",(0,n.jsx)(s.p,{children:"Whether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"source?"}),": ",(0,n.jsx)(s.code,{children:'"onMessage"'})," | ",(0,n.jsx)(s.code,{children:'"onAnyMessage"'})]}),"\n",(0,n.jsx)(s.p,{children:"The source of the message. This is useful for knowing if the message is from onMessage or onAnyMessage. Only processing one source will prevent duplicate processing."}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"Promise"}),"<",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})}),">"]})]})}function h(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>t,x:()=>a});var n=r(6540);const o={},c=n.createContext(o);function t(e){const s=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),n.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6cdb92a9.371b59c4.js b/assets/js/6cdb92a9.371b59c4.js deleted file mode 100644 index b14f7df027..0000000000 --- a/assets/js/6cdb92a9.371b59c4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2987],{6050:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=o(4848),n=o(8453);const i={title:"Socket mode",sidebar_position:4,description:"Guide showing how to develop your own solutions without needing to wait for session restarts."},r="Socket mode",d={id:"get-started/socketmode",title:"Socket mode",description:"Guide showing how to develop your own solutions without needing to wait for session restarts.",source:"@site/docs/get-started/socketmode.md",sourceDirName:"get-started",slug:"/get-started/socketmode",permalink:"/docs/get-started/socketmode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/socketmode.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Socket mode",sidebar_position:4,description:"Guide showing how to develop your own solutions without needing to wait for session restarts."},sidebar:"tutorialSidebar",previous:{title:"Link Code Login",permalink:"/docs/get-started/link-code"},next:{title:"The Config Object",permalink:"/docs/configuration/config-object"}},c={},a=[{value:"Step 1 - Start the EASY API in socket mode",id:"step-1---start-the-easy-api-in-socket-mode",level:2}];function u(e){const t={h1:"h1",h2:"h2",li:"li",p:"p",ul:"ul",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"socket-mode",children:"Socket mode"}),"\n",(0,s.jsx)(t.p,{children:"Now that you've checked out the EASY API and how to implement wa-automate with your own custom code I'm sure you're wondering if there was a best of both worlds? Yes there is! \"Socket mode\" allows you to seperate your session from your code and unlocks a number of benefits:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Your session and your code can be running on different servers"}),"\n",(0,s.jsx)(t.li,{children:"Rapid development - you no longer have to wait for a session to restart when restarting your custom code"}),"\n",(0,s.jsx)(t.li,{children:"1-many - connect multiple socket clients to one session."}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"How to:"}),"\n",(0,s.jsx)(t.h2,{id:"step-1---start-the-easy-api-in-socket-mode",children:"Step 1 - Start the EASY API in socket mode"})]})}function l(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>r,x:()=>d});var s=o(6540);const n={},i=s.createContext(n);function r(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6cdb92a9.b36632c4.js b/assets/js/6cdb92a9.b36632c4.js new file mode 100644 index 0000000000..4779fcd7a1 --- /dev/null +++ b/assets/js/6cdb92a9.b36632c4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2987],{6050:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=o(4848),n=o(8453);const i={title:"Socket mode",sidebar_position:4,description:"Guide showing how to develop your own solutions without needing to wait for session restarts."},r="Socket mode",d={id:"get-started/socketmode",title:"Socket mode",description:"Guide showing how to develop your own solutions without needing to wait for session restarts.",source:"@site/docs/get-started/socketmode.md",sourceDirName:"get-started",slug:"/get-started/socketmode",permalink:"/docs/get-started/socketmode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/socketmode.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Socket mode",sidebar_position:4,description:"Guide showing how to develop your own solutions without needing to wait for session restarts."},sidebar:"tutorialSidebar",previous:{title:"Link Code Login",permalink:"/docs/get-started/link-code"},next:{title:"The Config Object",permalink:"/docs/configuration/config-object"}},c={},a=[{value:"Step 1 - Start the EASY API in socket mode",id:"step-1---start-the-easy-api-in-socket-mode",level:2}];function u(e){const t={h1:"h1",h2:"h2",header:"header",li:"li",p:"p",ul:"ul",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"socket-mode",children:"Socket mode"})}),"\n",(0,s.jsx)(t.p,{children:"Now that you've checked out the EASY API and how to implement wa-automate with your own custom code I'm sure you're wondering if there was a best of both worlds? Yes there is! \"Socket mode\" allows you to seperate your session from your code and unlocks a number of benefits:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Your session and your code can be running on different servers"}),"\n",(0,s.jsx)(t.li,{children:"Rapid development - you no longer have to wait for a session to restart when restarting your custom code"}),"\n",(0,s.jsx)(t.li,{children:"1-many - connect multiple socket clients to one session."}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"How to:"}),"\n",(0,s.jsx)(t.h2,{id:"step-1---start-the-easy-api-in-socket-mode",children:"Step 1 - Start the EASY API in socket mode"})]})}function l(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>r,x:()=>d});var s=o(6540);const n={},i=s.createContext(n);function r(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6dda1eb8.ab42b8ef.js b/assets/js/6dda1eb8.ab42b8ef.js new file mode 100644 index 0000000000..0988e6aff5 --- /dev/null +++ b/assets/js/6dda1eb8.ab42b8ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7856],{4551:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var a=r(4848),t=r(8453);const i={},o="api/model/group-metadata",d={id:"reference/api/model/group-metadata/index",title:"api/model/group-metadata",description:"Index",source:"@site/docs/reference/api/model/group-metadata/index.md",sourceDirName:"reference/api/model/group-metadata",slug:"/reference/api/model/group-metadata/",permalink:"/docs/reference/api/model/group-metadata/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener"},next:{title:"Enumeration: GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes"}},c={},s=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"apimodelgroup-metadata",children:"api/model/group-metadata"})}),"\n",(0,a.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,a.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",children:"GroupNotificationTypes"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",children:"groupChangeEvent"})}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",children:"GenericGroupChangeEvent"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:"GroupMetadata"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:"NewCommunityGroup"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:"Participant"})}),"\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",children:"ParticipantChangedEventModel"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>d});var a=r(6540);const t={},i=a.createContext(t);function o(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6dda1eb8.d2f4de1f.js b/assets/js/6dda1eb8.d2f4de1f.js deleted file mode 100644 index 51bb45a81c..0000000000 --- a/assets/js/6dda1eb8.d2f4de1f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7856],{4551:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var r=a(4848),t=a(8453);const i={},o="api/model/group-metadata",d={id:"reference/api/model/group-metadata/index",title:"api/model/group-metadata",description:"Index",source:"@site/docs/reference/api/model/group-metadata/index.md",sourceDirName:"reference/api/model/group-metadata",slug:"/reference/api/model/group-metadata/",permalink:"/docs/reference/api/model/group-metadata/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener"},next:{title:"Enumeration: GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes"}},c={},s=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodelgroup-metadata",children:"api/model/group-metadata"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",children:"GroupNotificationTypes"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",children:"groupChangeEvent"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",children:"GenericGroupChangeEvent"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:"GroupMetadata"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:"NewCommunityGroup"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/Participant",children:"Participant"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",children:"ParticipantChangedEventModel"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>d});var r=a(6540);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6de276b4.77777957.js b/assets/js/6de276b4.77777957.js new file mode 100644 index 0000000000..47d91c012b --- /dev/null +++ b/assets/js/6de276b4.77777957.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6521],{6363:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var t=l(4848),r=l(8453);const a={},c="api/model/call",i={id:"reference/api/model/call/index",title:"api/model/call",description:"Index",source:"@site/docs/reference/api/model/call/index.md",sourceDirName:"reference/api/model/call",slug:"/reference/api/model/call/",permalink:"/docs/reference/api/model/call/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Section",permalink:"/docs/reference/api/model/button/interfaces/Section"},next:{title:"Enumeration: CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState"}},o={},s=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"apimodelcall",children:"api/model/call"})}),"\n",(0,t.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>c,x:()=>i});var t=l(6540);const r={},a=t.createContext(r);function c(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6de276b4.f2f5023f.js b/assets/js/6de276b4.f2f5023f.js deleted file mode 100644 index a854147084..0000000000 --- a/assets/js/6de276b4.f2f5023f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6521],{6363:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var l=t(4848),r=t(8453);const a={},c="api/model/call",i={id:"reference/api/model/call/index",title:"api/model/call",description:"Index",source:"@site/docs/reference/api/model/call/index.md",sourceDirName:"reference/api/model/call",slug:"/reference/api/model/call/",permalink:"/docs/reference/api/model/call/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Section",permalink:"/docs/reference/api/model/button/interfaces/Section"},next:{title:"Enumeration: CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState"}},o={},s=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h1,{id:"apimodelcall",children:"api/model/call"}),"\n",(0,l.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,l.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})}),"\n"]}),"\n",(0,l.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>i});var l=t(6540);const r={},a=l.createContext(r);function c(e){const n=l.useContext(a);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),l.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f5ae7fe.a07a81f6.js b/assets/js/6f5ae7fe.a07a81f6.js new file mode 100644 index 0000000000..e2cb388a4b --- /dev/null +++ b/assets/js/6f5ae7fe.a07a81f6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[998],{8642:(e,o,r)=>{r.r(o),r.d(o,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var t=r(4848),n=r(8453);const s={},a="Proxying your session",i={id:"how-to/use-a-proxy",title:"Proxying your session",description:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:",source:"@site/docs/how-to/use-a-proxy.md",sourceDirName:"how-to",slug:"/how-to/use-a-proxy",permalink:"/docs/how-to/use-a-proxy",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/use-a-proxy.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SendFile",permalink:"/docs/how-to/sendfile"},next:{title:"@open-wa/wa-automate v4.72.4",permalink:"/docs/reference/"}},d={},c=[];function p(e){const o={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.header,{children:(0,t.jsx)(o.h1,{id:"proxying-your-session",children:"Proxying your session"})}),"\n",(0,t.jsx)(o.p,{children:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-text",children:"//this is dummy data\n\nprotocol: http\naddress: proxyaddress.abc\nport: 1234\nusername: open-wa\npassword: antidote\n"})}),"\n",(0,t.jsx)(o.p,{children:"then your config will look something like this:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-javascript",children:"create({\n proxyServerCredentials: {\n address: 'http://proxyaddress.abc:1234',\n username: 'open-wa',\n password: 'antidote'\n }\n}).then(client => start(client));\n"})})]})}function u(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},8453:(e,o,r)=>{r.d(o,{R:()=>a,x:()=>i});var t=r(6540);const n={},s=t.createContext(n);function a(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f5ae7fe.d9e924b3.js b/assets/js/6f5ae7fe.d9e924b3.js deleted file mode 100644 index 8a4e5743a7..0000000000 --- a/assets/js/6f5ae7fe.d9e924b3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[998],{8642:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var n=t(4848),r=t(8453);const s={},a="Proxying your session",i={id:"how-to/use-a-proxy",title:"Proxying your session",description:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:",source:"@site/docs/how-to/use-a-proxy.md",sourceDirName:"how-to",slug:"/how-to/use-a-proxy",permalink:"/docs/how-to/use-a-proxy",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/use-a-proxy.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SendFile",permalink:"/docs/how-to/sendfile"},next:{title:"@open-wa/wa-automate v4.72.3",permalink:"/docs/reference/"}},c={},d=[];function p(e){const o={code:"code",h1:"h1",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"proxying-your-session",children:"Proxying your session"}),"\n",(0,n.jsx)(o.p,{children:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-text",children:"//this is dummy data\n\nprotocol: http\naddress: proxyaddress.abc\nport: 1234\nusername: open-wa\npassword: antidote\n"})}),"\n",(0,n.jsx)(o.p,{children:"then your config will look something like this:"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-javascript",children:"create({\n proxyServerCredentials: {\n address: 'http://proxyaddress.abc:1234',\n username: 'open-wa',\n password: 'antidote'\n }\n}).then(client => start(client));\n"})})]})}function u(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>a,x:()=>i});var n=t(6540);const r={},s=n.createContext(r);function a(e){const o=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f941ca8.1395f5c1.js b/assets/js/6f941ca8.1395f5c1.js new file mode 100644 index 0000000000..856c754c2c --- /dev/null +++ b/assets/js/6f941ca8.1395f5c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6155],{3135:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>r});var o=t(4848),i=t(8453);const a={},c="Location",s={id:"how-to/location",title:"Location",description:"Sending Location",source:"@site/docs/how-to/location.md",sourceDirName:"how-to",slug:"/how-to/location",permalink:"/docs/how-to/location",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/location.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Handle Incoming Call",permalink:"/docs/how-to/incoming-calls"},next:{title:"Manage Participants",permalink:"/docs/how-to/manage-participants"}},l={},r=[{value:"Sending Location",id:"sending-location",level:2},{value:"Receiving Location",id:"receiving-location",level:2},{value:"Listening to Live Locations",id:"listening-to-live-locations",level:2},{value:"Forcing Live Locations to Update",id:"forcing-live-locations-to-update",level:3}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"location",children:"Location"})}),"\n",(0,o.jsx)(n.h2,{id:"sending-location",children:"Sending Location"}),"\n",(0,o.jsx)(n.p,{children:"[[sendLocation]]"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" client.sendLocation(chatId, latitude, longitude, 'London!')\n"})}),"\n",(0,o.jsx)(n.h2,{id:"receiving-location",children:"Receiving Location"}),"\n",(0,o.jsx)(n.p,{children:"Check the [[Message]] reference to learn how to extract the coordinates from a location message"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:' client.onMessage(message=> {\n if(message.type==="location") {\n //Using destructuring\n const {\n // The text associated with the location\n loc,\n //Latitude\n lat,\n //Longitude\n lng\n } = message\n }\n })\n'})}),"\n",(0,o.jsx)(n.h2,{id:"listening-to-live-locations",children:"Listening to Live Locations"}),"\n",(0,o.jsx)(n.p,{children:"[[onLiveLocation]] fires a [[LiveLocationChangedEvent]] event. [[onLiveLocation]] requires a chat id to listen to so you need to detect exactly when a chat starts sharing a live location with your host account. This example detects when a live location is started and then registers a new callback to listen to updates in that live location session."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" const liveLocationCallback = currentLiveLocation => {\n console.log('Live location update', currentLiveLocation.id, currentLiveLocation.lat, currentLiveLocation.lng);\n }\n client.onMessage(message=> {\n //This is how to detect when someone has started a live location with you\n if(message.shareDuration){\n client.onLiveLocation(message.from, liveLocationCallback)\n }\n })\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"forcing-live-locations-to-update",children:"Forcing Live Locations to Update"}),"\n",(0,o.jsx)(n.p,{children:"The updates of live locations are very passive. If you require updates at regular intervals then you can force it using [[forceUpdateLiveLocation]]. It is recomended to keep an array of chat ids that have live location sessions and map through them at regular intervals"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" await client.forceUpdateLiveLocation(chatId);\n\n //or force update live locations of multiple chats\n await Promise.all([\n 'chatId1',\n 'chatId2'\n ].map(client.forceUpdateLiveLocation));\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const i={},a=o.createContext(i);function c(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f941ca8.df1e365a.js b/assets/js/6f941ca8.df1e365a.js deleted file mode 100644 index c8338a4842..0000000000 --- a/assets/js/6f941ca8.df1e365a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6155],{3135:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>r});var o=t(4848),i=t(8453);const a={},c="Location",s={id:"how-to/location",title:"Location",description:"Sending Location",source:"@site/docs/how-to/location.md",sourceDirName:"how-to",slug:"/how-to/location",permalink:"/docs/how-to/location",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/location.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Handle Incoming Call",permalink:"/docs/how-to/incoming-calls"},next:{title:"Manage Participants",permalink:"/docs/how-to/manage-participants"}},l={},r=[{value:"Sending Location",id:"sending-location",level:2},{value:"Receiving Location",id:"receiving-location",level:2},{value:"Listening to Live Locations",id:"listening-to-live-locations",level:2},{value:"Forcing Live Locations to Update",id:"forcing-live-locations-to-update",level:3}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"location",children:"Location"}),"\n",(0,o.jsx)(n.h2,{id:"sending-location",children:"Sending Location"}),"\n",(0,o.jsx)(n.p,{children:"[[sendLocation]]"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" client.sendLocation(chatId, latitude, longitude, 'London!')\n"})}),"\n",(0,o.jsx)(n.h2,{id:"receiving-location",children:"Receiving Location"}),"\n",(0,o.jsx)(n.p,{children:"Check the [[Message]] reference to learn how to extract the coordinates from a location message"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:' client.onMessage(message=> {\n if(message.type==="location") {\n //Using destructuring\n const {\n // The text associated with the location\n loc,\n //Latitude\n lat,\n //Longitude\n lng\n } = message\n }\n })\n'})}),"\n",(0,o.jsx)(n.h2,{id:"listening-to-live-locations",children:"Listening to Live Locations"}),"\n",(0,o.jsx)(n.p,{children:"[[onLiveLocation]] fires a [[LiveLocationChangedEvent]] event. [[onLiveLocation]] requires a chat id to listen to so you need to detect exactly when a chat starts sharing a live location with your host account. This example detects when a live location is started and then registers a new callback to listen to updates in that live location session."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" const liveLocationCallback = currentLiveLocation => {\n console.log('Live location update', currentLiveLocation.id, currentLiveLocation.lat, currentLiveLocation.lng);\n }\n client.onMessage(message=> {\n //This is how to detect when someone has started a live location with you\n if(message.shareDuration){\n client.onLiveLocation(message.from, liveLocationCallback)\n }\n })\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"forcing-live-locations-to-update",children:"Forcing Live Locations to Update"}),"\n",(0,o.jsx)(n.p,{children:"The updates of live locations are very passive. If you require updates at regular intervals then you can force it using [[forceUpdateLiveLocation]]. It is recomended to keep an array of chat ids that have live location sessions and map through them at regular intervals"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:" await client.forceUpdateLiveLocation(chatId);\n\n //or force update live locations of multiple chats\n await Promise.all([\n 'chatId1',\n 'chatId2'\n ].map(client.forceUpdateLiveLocation));\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const i={},a=o.createContext(i);function c(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70bd31a0.0e22edf3.js b/assets/js/70bd31a0.0e22edf3.js deleted file mode 100644 index 73492bb58c..0000000000 --- a/assets/js/70bd31a0.0e22edf3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[727],{5705:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),r=n(8453);const o={},c="Interface: BusinessProfile",l={id:"reference/api/model/contact/interfaces/BusinessProfile",title:"Interface: BusinessProfile",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BusinessProfile.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BusinessProfile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours"},next:{title:"Interface: Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact"}},t={},d=[{value:"Properties",id:"properties",level:2},{value:"address",id:"address",level:3},{value:"businessHours",id:"businesshours",level:3},{value:"catalogStatus",id:"catalogstatus",level:3},{value:"categories",id:"categories",level:3},{value:"coverPhoto",id:"coverphoto",level:3},{value:"id",id:"id",level:4},{value:"url",id:"url",level:4},{value:"description",id:"description",level:3},{value:"email",id:"email",level:3},{value:"fbPage",id:"fbpage",level:3},{value:"id",id:"id-1",level:3},{value:"igProfessional",id:"igprofessional",level:3},{value:"isProfileLinked",id:"isprofilelinked",level:3},{value:"latitude",id:"latitude",level:3},{value:"longitude",id:"longitude",level:3},{value:"profileOptions",id:"profileoptions",level:3},{value:"tag",id:"tag",level:3},{value:"website",id:"website",level:3}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-businessprofile",children:"Interface: BusinessProfile"}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"address",children:"address"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"address"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The address of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"businesshours",children:"businessHours"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"businessHours"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:(0,i.jsx)(s.code,{children:"BusinessHours"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The operating hours of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"catalogstatus",children:"catalogStatus"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"catalogStatus"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The status of the business' catalog"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"categories",children:"categories"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"categories"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:(0,i.jsx)(s.code,{children:"BizCategory"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' categories"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"coverphoto",children:"coverPhoto"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"coverPhoto"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The id of the cover photo"}),"\n",(0,i.jsx)(s.h4,{id:"url",children:"url"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"url"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The URL of the cover photo. It might download as an .enc but just change the extension to .jpg"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"description",children:"description"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"description"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business description"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"email",children:"email"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"email"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' email address"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"fbpage",children:"fbPage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"fbPage"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The facebook page of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The Contact ID of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"igprofessional",children:"igProfessional"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"igProfessional"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The instagram profile of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isprofilelinked",children:"isProfileLinked"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isProfileLinked"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"latitude",children:"latitude"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"latitude"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The latitude of the business location if set"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"longitude",children:"longitude"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"longitude"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The longitude of the business location if set"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"profileoptions",children:"profileOptions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"profileOptions"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:(0,i.jsx)(s.code,{children:"BizProfileOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' profile options"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"tag",children:"tag"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"tag"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Some special string that identifies the business (?)"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"website",children:"website"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"website"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Array of strings that represent the business' websites"})]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>l});var i=n(6540);const r={},o=i.createContext(r);function c(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70bd31a0.f04fd0d6.js b/assets/js/70bd31a0.f04fd0d6.js new file mode 100644 index 0000000000..f560e2b157 --- /dev/null +++ b/assets/js/70bd31a0.f04fd0d6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[727],{5705:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),r=n(8453);const o={},c="Interface: BusinessProfile",l={id:"reference/api/model/contact/interfaces/BusinessProfile",title:"Interface: BusinessProfile",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BusinessProfile.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BusinessProfile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours"},next:{title:"Interface: Contact",permalink:"/docs/reference/api/model/contact/interfaces/Contact"}},t={},d=[{value:"Properties",id:"properties",level:2},{value:"address",id:"address",level:3},{value:"businessHours",id:"businesshours",level:3},{value:"catalogStatus",id:"catalogstatus",level:3},{value:"categories",id:"categories",level:3},{value:"coverPhoto",id:"coverphoto",level:3},{value:"id",id:"id",level:4},{value:"url",id:"url",level:4},{value:"description",id:"description",level:3},{value:"email",id:"email",level:3},{value:"fbPage",id:"fbpage",level:3},{value:"id",id:"id-1",level:3},{value:"igProfessional",id:"igprofessional",level:3},{value:"isProfileLinked",id:"isprofilelinked",level:3},{value:"latitude",id:"latitude",level:3},{value:"longitude",id:"longitude",level:3},{value:"profileOptions",id:"profileoptions",level:3},{value:"tag",id:"tag",level:3},{value:"website",id:"website",level:3}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"interface-businessprofile",children:"Interface: BusinessProfile"})}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"address",children:"address"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"address"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The address of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"businesshours",children:"businessHours"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"businessHours"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:(0,i.jsx)(s.code,{children:"BusinessHours"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The operating hours of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"catalogstatus",children:"catalogStatus"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"catalogStatus"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The status of the business' catalog"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"categories",children:"categories"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"categories"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:(0,i.jsx)(s.code,{children:"BizCategory"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' categories"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"coverphoto",children:"coverPhoto"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"coverPhoto"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The id of the cover photo"}),"\n",(0,i.jsx)(s.h4,{id:"url",children:"url"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"url"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The URL of the cover photo. It might download as an .enc but just change the extension to .jpg"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"description",children:"description"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"description"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business description"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"email",children:"email"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"email"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' email address"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"fbpage",children:"fbPage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"fbPage"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The facebook page of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The Contact ID of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"igprofessional",children:"igProfessional"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"igProfessional"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The instagram profile of the business"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isprofilelinked",children:"isProfileLinked"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isProfileLinked"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"latitude",children:"latitude"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"latitude"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The latitude of the business location if set"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"longitude",children:"longitude"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"longitude"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The longitude of the business location if set"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"profileoptions",children:"profileOptions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"profileOptions"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:(0,i.jsx)(s.code,{children:"BizProfileOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The business' profile options"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"tag",children:"tag"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"tag"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Some special string that identifies the business (?)"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"website",children:"website"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"website"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Array of strings that represent the business' websites"})]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>l});var i=n(6540);const r={},o=i.createContext(r);function c(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71e949d7.446769d4.js b/assets/js/71e949d7.446769d4.js deleted file mode 100644 index 5e9bd00591..0000000000 --- a/assets/js/71e949d7.446769d4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1623],{830:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>v,frontMatter:()=>o,metadata:()=>a,toc:()=>i});var t=s(4848),r=s(8453);const o={},c="Variable: ev",a={id:"reference/controllers/events/variables/ev",title:"Variable: ev",description:"const ev: EventEmitter2",source:"@site/docs/reference/controllers/events/variables/ev.md",sourceDirName:"reference/controllers/events/variables",slug:"/reference/controllers/events/variables/ev",permalink:"/docs/reference/controllers/events/variables/ev",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/events/variables/ev.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/events",permalink:"/docs/reference/controllers/events/"},next:{title:"controllers/init\\_patch",permalink:"/docs/reference/controllers/init_patch/"}},l={},i=[];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-ev",children:"Variable: ev"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"ev"}),": ",(0,t.jsx)(n.code,{children:"EventEmitter2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This is the library's event emitter. Use this to listen to internal events of the library like so:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('event', callback)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The event you want to listen to is in the format of [namespace].[sessionId]"}),"\n",(0,t.jsx)(n.p,{children:"The event can include wildcards."}),"\n",(0,t.jsxs)(n.p,{children:["For example, to listen to all qr code events, the event will be ",(0,t.jsx)(n.code,{children:"qr.**"}),". e.g:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('qr.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all sessionData events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('sessionData.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events from session1"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.session1',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**', (data, sessionId, namespace) => {\n\n console.log(`${namespace} event detected for session ${sessionId}`, data)\n\n});\n"})})]})}function v(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>a});var t=s(6540);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71e949d7.c6634281.js b/assets/js/71e949d7.c6634281.js new file mode 100644 index 0000000000..4cb50f5398 --- /dev/null +++ b/assets/js/71e949d7.c6634281.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1623],{830:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>v,frontMatter:()=>o,metadata:()=>c,toc:()=>i});var t=s(4848),r=s(8453);const o={},a="Variable: ev",c={id:"reference/controllers/events/variables/ev",title:"Variable: ev",description:"const ev: EventEmitter2",source:"@site/docs/reference/controllers/events/variables/ev.md",sourceDirName:"reference/controllers/events/variables",slug:"/reference/controllers/events/variables/ev",permalink:"/docs/reference/controllers/events/variables/ev",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/events/variables/ev.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/events",permalink:"/docs/reference/controllers/events/"},next:{title:"controllers/init\\_patch",permalink:"/docs/reference/controllers/init_patch/"}},l={},i=[];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"variable-ev",children:"Variable: ev"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"ev"}),": ",(0,t.jsx)(n.code,{children:"EventEmitter2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This is the library's event emitter. Use this to listen to internal events of the library like so:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('event', callback)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The event you want to listen to is in the format of [namespace].[sessionId]"}),"\n",(0,t.jsx)(n.p,{children:"The event can include wildcards."}),"\n",(0,t.jsxs)(n.p,{children:["For example, to listen to all qr code events, the event will be ",(0,t.jsx)(n.code,{children:"qr.**"}),". e.g:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('qr.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all sessionData events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('sessionData.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events from session1"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.session1',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"Listen to all events"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**',...\n"})}),"\n",(0,t.jsx)(n.p,{children:"ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"ev.on('**.**', (data, sessionId, namespace) => {\n\n console.log(`${namespace} event detected for session ${sessionId}`, data)\n\n});\n"})})]})}function v(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>c});var t=s(6540);const r={},o=t.createContext(r);function a(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72bcfeeb.4df11037.js b/assets/js/72bcfeeb.4df11037.js deleted file mode 100644 index b4e053c4db..0000000000 --- a/assets/js/72bcfeeb.4df11037.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3795],{6506:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=t(4848),i=t(8453);const s={},c="Function: create()",o={id:"reference/controllers/initializer/functions/create",title:"Function: create()",description:"create(config): Promise\\",source:"@site/docs/reference/controllers/initializer/functions/create.md",sourceDirName:"reference/controllers/initializer/functions",slug:"/reference/controllers/initializer/functions/create",permalink:"/docs/reference/controllers/initializer/functions/create",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/functions/create.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/initializer",permalink:"/docs/reference/controllers/initializer/"},next:{title:"Function: timeout()",permalink:"/docs/reference/controllers/initializer/functions/timeout"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-create",children:"Function: create()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"config"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,r.jsx)(n.code,{children:"Client"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Used to initialize the client session."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.em,{children:"Note"})," It is required to set all config variables as ",(0,r.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/interfaces/configobject.html",children:"ConfigObject"})," that includes both ",(0,r.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/interfaces/configobject.html#sessionId",children:"sessionId"}),". Setting the session id as the first variable is no longer valid"]}),"\n",(0,r.jsx)(n.p,{children:"e.g"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-javascript",children:"create({\nsessionId: 'main',\ncustomUserAgent: ' 'WhatsApp/2.16.352 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Safari/605.1.15',\nblockCrashLogs true,\n...\n})....\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"config"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(n.code,{children:"ConfigObject"})})," | ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:(0,r.jsx)(n.code,{children:"AdvancedConfig"})})," = ",(0,r.jsx)(n.code,{children:"{}"})]}),"\n",(0,r.jsx)(n.p,{children:"AdvancedConfig The extended custom configuration"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,r.jsx)(n.code,{children:"Client"})}),">"]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const i={},s=r.createContext(i);function c(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72bcfeeb.cabe5abe.js b/assets/js/72bcfeeb.cabe5abe.js new file mode 100644 index 0000000000..777179205e --- /dev/null +++ b/assets/js/72bcfeeb.cabe5abe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3795],{6506:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=r(4848),i=r(8453);const s={},c="Function: create()",o={id:"reference/controllers/initializer/functions/create",title:"Function: create()",description:"create(config): Promise\\",source:"@site/docs/reference/controllers/initializer/functions/create.md",sourceDirName:"reference/controllers/initializer/functions",slug:"/reference/controllers/initializer/functions/create",permalink:"/docs/reference/controllers/initializer/functions/create",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/initializer/functions/create.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"controllers/initializer",permalink:"/docs/reference/controllers/initializer/"},next:{title:"Function: timeout()",permalink:"/docs/reference/controllers/initializer/functions/timeout"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-create",children:"Function: create()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"create"}),"(",(0,t.jsx)(n.code,{children:"config"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,t.jsx)(n.code,{children:"Client"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Used to initialize the client session."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.em,{children:"Note"})," It is required to set all config variables as ",(0,t.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/interfaces/configobject.html",children:"ConfigObject"})," that includes both ",(0,t.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/interfaces/configobject.html#sessionId",children:"sessionId"}),". Setting the session id as the first variable is no longer valid"]}),"\n",(0,t.jsx)(n.p,{children:"e.g"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"create({\nsessionId: 'main',\ncustomUserAgent: ' 'WhatsApp/2.16.352 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Safari/605.1.15',\nblockCrashLogs true,\n...\n})....\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"config"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,t.jsx)(n.code,{children:"ConfigObject"})})," | ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:(0,t.jsx)(n.code,{children:"AdvancedConfig"})})," = ",(0,t.jsx)(n.code,{children:"{}"})]}),"\n",(0,t.jsx)(n.p,{children:"AdvancedConfig The extended custom configuration"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:(0,t.jsx)(n.code,{children:"Client"})}),">"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>o});var t=r(6540);const i={},s=t.createContext(i);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73664a40.9cfceefb.js b/assets/js/73664a40.9cfceefb.js new file mode 100644 index 0000000000..025fa8a9d0 --- /dev/null +++ b/assets/js/73664a40.9cfceefb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1972],{9581:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>l,contentTitle:()=>u,default:()=>a,frontMatter:()=>n,metadata:()=>r,toc:()=>m});var t=i(4848),o=i(8453);const n={slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},u=void 0,r={permalink:"/blog/long-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md",source:"@site/blog/2019-05-29-long-blog-post.md",title:"Long Blog Post",description:"This is the summary of a very long blog post,",date:"2019-05-29T00:00:00.000Z",tags:[{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:2.05,hasTruncateMarker:!0,authors:[{name:"Endilie Yacop Sucipto",title:"Maintainer of Docusaurus",url:"https://github.com/endiliey",imageURL:"https://github.com/endiliey.png",key:"endi",page:null}],frontMatter:{slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},unlisted:!1,prevItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"},nextItem:{title:"First Blog Post",permalink:"/blog/first-blog-post"}},l={authorsImageUrls:[void 0]},m=[];function c(e){const s={code:"code",p:"p",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.p,{children:"This is the summary of a very long blog post,"}),"\n",(0,t.jsxs)(s.p,{children:["Use a ",(0,t.jsx)(s.code,{children:"\x3c!--"})," ",(0,t.jsx)(s.code,{children:"truncate"})," ",(0,t.jsx)(s.code,{children:"--\x3e"})," comment to limit blog post size in the list view."]}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})]})}function a(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,s,i)=>{i.d(s,{R:()=>u,x:()=>r});var t=i(6540);const o={},n=t.createContext(o);function u(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:u(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73664a40.cd7a7421.js b/assets/js/73664a40.cd7a7421.js deleted file mode 100644 index 55a700e423..0000000000 --- a/assets/js/73664a40.cd7a7421.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1972],{9581:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>l,contentTitle:()=>u,default:()=>a,frontMatter:()=>n,metadata:()=>r,toc:()=>m});var t=i(4848),o=i(8453);const n={slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},u=void 0,r={permalink:"/blog/long-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md",source:"@site/blog/2019-05-29-long-blog-post.md",title:"Long Blog Post",description:"This is the summary of a very long blog post,",date:"2019-05-29T00:00:00.000Z",tags:[{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:2.05,hasTruncateMarker:!0,authors:[{name:"Endilie Yacop Sucipto",title:"Maintainer of Docusaurus",url:"https://github.com/endiliey",imageURL:"https://github.com/endiliey.png",key:"endi"}],frontMatter:{slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},unlisted:!1,prevItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"},nextItem:{title:"First Blog Post",permalink:"/blog/first-blog-post"}},l={authorsImageUrls:[void 0]},m=[];function c(e){const s={code:"code",p:"p",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.p,{children:"This is the summary of a very long blog post,"}),"\n",(0,t.jsxs)(s.p,{children:["Use a ",(0,t.jsx)(s.code,{children:"\x3c!--"})," ",(0,t.jsx)(s.code,{children:"truncate"})," ",(0,t.jsx)(s.code,{children:"--\x3e"})," comment to limit blog post size in the list view."]}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}),"\n",(0,t.jsx)(s.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})]})}function a(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,s,i)=>{i.d(s,{R:()=>u,x:()=>r});var t=i(6540);const o={},n=t.createContext(o);function u(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:u(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73c627ad.610d16b0.js b/assets/js/73c627ad.610d16b0.js new file mode 100644 index 0000000000..882be02040 --- /dev/null +++ b/assets/js/73c627ad.610d16b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{4933:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>a});var t=n(4848),c=n(8453);const s={},o="Interface: CustomProduct",i={id:"reference/api/model/product/interfaces/CustomProduct",title:"Interface: CustomProduct",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/CustomProduct.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/CustomProduct.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"},next:{title:"Interface: Order",permalink:"/docs/reference/api/model/product/interfaces/Order"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"currency",id:"currency",level:3},{value:"description",id:"description",level:3},{value:"name",id:"name",level:3},{value:"priceAmount1000",id:"priceamount1000",level:3},{value:"url?",id:"url",level:3}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"interface-customproduct",children:"Interface: CustomProduct"})}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"currency",children:"currency"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"currency"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The ",(0,t.jsx)(r.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,t.jsx)(r.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,t.jsx)(r.code,{children:"SEK"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"description",children:"description"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"description"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"The description of the product. This shows right under the price so it is useful for subscriptions/rentals. E.g:"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"(per day)\\n\\nCome and have a fantastic sailing adventure aboard our boat. \\nShe is a Bavaria 35 sports cruiser and is powered by 2 economical Volvo D6\u2019s with Bravo 2 outdrives as well as a bow thruster. This Makes maneuvering very easy. She can accommodate up to 8 people for day charters and for overnight charters she can accommodate 4 in comfort in 2 cabins."})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The main title of the product. E.g:\n",(0,t.jsx)(r.code,{children:"BAVARIA \u2014 35 SPORTS CRUISER (2006)"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"priceamount1000",children:"priceAmount1000"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"priceAmount1000"}),": ",(0,t.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The price amount multiplied by 1000. For example, for something costing ",(0,t.jsx)(r.code,{children:"825"})," units of currency:\n",(0,t.jsx)(r.code,{children:"825000"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"url",children:"url?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"url"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"The URL of the product."}),"\n",(0,t.jsx)(r.p,{children:"NOTE: At the moment, the URL DOES NOT WORK. It shows up for the recipient but they will not be able to click it. As a rememdy, it is added as a reply to the product message."})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>i});var t=n(6540);const c={},s=t.createContext(c);function o(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73c627ad.f33f76ec.js b/assets/js/73c627ad.f33f76ec.js deleted file mode 100644 index ef329166c5..0000000000 --- a/assets/js/73c627ad.f33f76ec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{4933:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>a});var t=n(4848),c=n(8453);const s={},o="Interface: CustomProduct",i={id:"reference/api/model/product/interfaces/CustomProduct",title:"Interface: CustomProduct",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/CustomProduct.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/CustomProduct.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"},next:{title:"Interface: Order",permalink:"/docs/reference/api/model/product/interfaces/Order"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"currency",id:"currency",level:3},{value:"description",id:"description",level:3},{value:"name",id:"name",level:3},{value:"priceAmount1000",id:"priceamount1000",level:3},{value:"url?",id:"url",level:3}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-customproduct",children:"Interface: CustomProduct"}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"currency",children:"currency"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"currency"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The ",(0,t.jsx)(r.a,{href:"https://en.wikipedia.org/wiki/ISO_4217",children:(0,t.jsx)(r.strong,{children:"ISO 4217"})})," 3 letter currency code. E.g (Swedish krona)\n",(0,t.jsx)(r.code,{children:"SEK"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"description",children:"description"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"description"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"The description of the product. This shows right under the price so it is useful for subscriptions/rentals. E.g:"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"(per day)\\n\\nCome and have a fantastic sailing adventure aboard our boat. \\nShe is a Bavaria 35 sports cruiser and is powered by 2 economical Volvo D6\u2019s with Bravo 2 outdrives as well as a bow thruster. This Makes maneuvering very easy. She can accommodate up to 8 people for day charters and for overnight charters she can accommodate 4 in comfort in 2 cabins."})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The main title of the product. E.g:\n",(0,t.jsx)(r.code,{children:"BAVARIA \u2014 35 SPORTS CRUISER (2006)"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"priceamount1000",children:"priceAmount1000"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"priceAmount1000"}),": ",(0,t.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["The price amount multiplied by 1000. For example, for something costing ",(0,t.jsx)(r.code,{children:"825"})," units of currency:\n",(0,t.jsx)(r.code,{children:"825000"})]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"url",children:"url?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"url"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"The URL of the product."}),"\n",(0,t.jsx)(r.p,{children:"NOTE: At the moment, the URL DOES NOT WORK. It shows up for the recipient but they will not be able to click it. As a rememdy, it is added as a reply to the product message."})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>i});var t=n(6540);const c={},s=t.createContext(c);function o(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73d41d19.da269f44.js b/assets/js/73d41d19.da269f44.js new file mode 100644 index 0000000000..792167c9a8 --- /dev/null +++ b/assets/js/73d41d19.da269f44.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5352],{2970:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var n=s(4848),i=s(8453);const a={},l="api/model",d={id:"reference/api/model/index",title:"api/model",description:"Index",source:"@site/docs/reference/api/model/index.md",sourceDirName:"reference/api/model",slug:"/reference/api/model/",permalink:"/docs/reference/api/model/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"},next:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"}},o={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"References",id:"references",level:2},{value:"AccountNumber",id:"accountnumber",level:3},{value:"AddParticipantError",id:"addparticipanterror",level:3},{value:"AddParticipantErrorStatusCode",id:"addparticipanterrorstatuscode",level:3},{value:"AdvancedConfig",id:"advancedconfig",level:3},{value:"AdvancedFile",id:"advancedfile",level:3},{value:"Base64",id:"base64",level:3},{value:"BaseChat",id:"basechat",level:3},{value:"BizCategory",id:"bizcategory",level:3},{value:"BizProfileOptions",id:"bizprofileoptions",level:3},{value:"BusinessHours",id:"businesshours",level:3},{value:"BusinessProfile",id:"businessprofile",level:3},{value:"CLOUD_PROVIDERS",id:"cloud_providers",level:3},{value:"Call",id:"call",level:3},{value:"CallState",id:"callstate",level:3},{value:"CartItem",id:"cartitem",level:3},{value:"Chat",id:"chat",level:3},{value:"ChatId",id:"chatid",level:3},{value:"ChatMuteDuration",id:"chatmuteduration",level:3},{value:"ChatServer",id:"chatserver",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ChatTypes",id:"chattypes",level:3},{value:"ConfigObject",id:"configobject",level:3},{value:"Contact",id:"contact",level:3},{value:"ContactId",id:"contactid",level:3},{value:"Content",id:"content",level:3},{value:"CountryCode",id:"countrycode",level:3},{value:"CustomError",id:"customerror",level:3},{value:"CustomProduct",id:"customproduct",level:3},{value:"DIRECTORY_STRATEGY",id:"directory_strategy",level:3},{value:"DataURL",id:"dataurl",level:3},{value:"DevTools",id:"devtools",level:3},{value:"ERROR_NAME",id:"error_name",level:3},{value:"EphemeralDuration",id:"ephemeralduration",level:3},{value:"EventPayload",id:"eventpayload",level:3},{value:"FilePath",id:"filepath",level:3},{value:"GetURL",id:"geturl",level:3},{value:"GroupChat",id:"groupchat",level:3},{value:"GroupChatCreationParticipantAddResponse",id:"groupchatcreationparticipantaddresponse",level:3},{value:"GroupChatCreationResponse",id:"groupchatcreationresponse",level:3},{value:"GroupChatId",id:"groupchatid",level:3},{value:"GroupChatServer",id:"groupchatserver",level:3},{value:"GroupId",id:"groupid",level:3},{value:"Label",id:"label",level:3},{value:"LicenseType",id:"licensetype",level:3},{value:"LiveLocationChangedEvent",id:"livelocationchangedevent",level:3},{value:"Message",id:"message",level:3},{value:"MessageAck",id:"messageack",level:3},{value:"MessageId",id:"messageid",level:3},{value:"MessageInfo",id:"messageinfo",level:3},{value:"MessageInfoInteraction",id:"messageinfointeraction",level:3},{value:"MessageTypes",id:"messagetypes",level:3},{value:"Mp4StickerConversionProcessOptions",id:"mp4stickerconversionprocessoptions",level:3},{value:"NonSerializedId",id:"nonserializedid",level:3},{value:"NotificationLanguage",id:"notificationlanguage",level:3},{value:"NumberCheck",id:"numbercheck",level:3},{value:"OnError",id:"onerror",level:3},{value:"Order",id:"order",level:3},{value:"PageEvaluationTimeout",id:"pageevaluationtimeout",level:3},{value:"PollData",id:"polldata",level:3},{value:"PollOption",id:"polloption",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Product",id:"product",level:3},{value:"ProxyServerCredentials",id:"proxyservercredentials",level:3},{value:"QRFormat",id:"qrformat",level:3},{value:"QRQuality",id:"qrquality",level:3},{value:"QuoteMap",id:"quotemap",level:3},{value:"Reaction",id:"reaction",level:3},{value:"ReactionEvent",id:"reactionevent",level:3},{value:"ReactionRecord",id:"reactionrecord",level:3},{value:"ReactionSender",id:"reactionsender",level:3},{value:"SessionData",id:"sessiondata",level:3},{value:"SessionExpiredError",id:"sessionexpirederror",level:3},{value:"SimpleListener",id:"simplelistener",level:3},{value:"SingleChat",id:"singlechat",level:3},{value:"StickerMetadata",id:"stickermetadata",level:3},{value:"WaServers",id:"waservers",level:3},{value:"Webhook",id:"webhook",level:3},{value:"defaultProcessOptions",id:"defaultprocessoptions",level:3}];function t(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodel",children:"api/model"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Events",children:"Events"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/STATE",children:"STATE"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Status",children:"Status"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/type-aliases/EasyApiResponse",children:"EasyApiResponse"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"references",children:"References"}),"\n",(0,n.jsx)(r.h3,{id:"accountnumber",children:"AccountNumber"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterror",children:"AddParticipantError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterrorstatuscode",children:"AddParticipantErrorStatusCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedconfig",children:"AdvancedConfig"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedfile",children:"AdvancedFile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"base64",children:"Base64"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"basechat",children:"BaseChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizcategory",children:"BizCategory"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizprofileoptions",children:"BizProfileOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businesshours",children:"BusinessHours"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businessprofile",children:"BusinessProfile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cloud_providers",children:"CLOUD_PROVIDERS"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"Call"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"callstate",children:"CallState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cartitem",children:"CartItem"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chat",children:"Chat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatid",children:"ChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatmuteduration",children:"ChatMuteDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatserver",children:"ChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chattypes",children:"ChatTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"configobject",children:"ConfigObject"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contact",children:"Contact"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contactid",children:"ContactId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"content",children:"Content"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"countrycode",children:"CountryCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customerror",children:"CustomError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customproduct",children:"CustomProduct"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"directory_strategy",children:"DIRECTORY_STRATEGY"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"dataurl",children:"DataURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"devtools",children:"DevTools"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"error_name",children:"ERROR_NAME"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ephemeralduration",children:"EphemeralDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"eventpayload",children:"EventPayload"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"filepath",children:"FilePath"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"geturl",children:"GetURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchat",children:"GroupChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationparticipantaddresponse",children:"GroupChatCreationParticipantAddResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationresponse",children:"GroupChatCreationResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatid",children:"GroupChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatserver",children:"GroupChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupid",children:"GroupId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"Label"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"licensetype",children:"LicenseType"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"livelocationchangedevent",children:"LiveLocationChangedEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"Message"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageack",children:"MessageAck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageid",children:"MessageId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfo",children:"MessageInfo"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfointeraction",children:"MessageInfoInteraction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messagetypes",children:"MessageTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"mp4stickerconversionprocessoptions",children:"Mp4StickerConversionProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"nonserializedid",children:"NonSerializedId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"notificationlanguage",children:"NotificationLanguage"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"numbercheck",children:"NumberCheck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"onerror",children:"OnError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"order",children:"Order"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pageevaluationtimeout",children:"PageEvaluationTimeout"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polldata",children:"PollData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polloption",children:"PollOption"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"product",children:"Product"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"proxyservercredentials",children:"ProxyServerCredentials"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrformat",children:"QRFormat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrquality",children:"QRQuality"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"quotemap",children:"QuoteMap"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reaction",children:"Reaction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionevent",children:"ReactionEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionrecord",children:"ReactionRecord"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionsender",children:"ReactionSender"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessiondata",children:"SessionData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessionexpirederror",children:"SessionExpiredError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"simplelistener",children:"SimpleListener"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"singlechat",children:"SingleChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stickermetadata",children:"StickerMetadata"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"waservers",children:"WaServers"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"webhook",children:"Webhook"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"defaultprocessoptions",children:"defaultProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})]})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(t,{...e})}):t(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>d});var n=s(6540);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73d41d19.f58dea4d.js b/assets/js/73d41d19.f58dea4d.js deleted file mode 100644 index 9eac3c2915..0000000000 --- a/assets/js/73d41d19.f58dea4d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5352],{2970:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var n=s(4848),i=s(8453);const a={},l="api/model",d={id:"reference/api/model/index",title:"api/model",description:"Index",source:"@site/docs/reference/api/model/index.md",sourceDirName:"reference/api/model",slug:"/reference/api/model/",permalink:"/docs/reference/api/model/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"},next:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"}},o={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"References",id:"references",level:2},{value:"AccountNumber",id:"accountnumber",level:3},{value:"AddParticipantError",id:"addparticipanterror",level:3},{value:"AddParticipantErrorStatusCode",id:"addparticipanterrorstatuscode",level:3},{value:"AdvancedConfig",id:"advancedconfig",level:3},{value:"AdvancedFile",id:"advancedfile",level:3},{value:"Base64",id:"base64",level:3},{value:"BaseChat",id:"basechat",level:3},{value:"BizCategory",id:"bizcategory",level:3},{value:"BizProfileOptions",id:"bizprofileoptions",level:3},{value:"BusinessHours",id:"businesshours",level:3},{value:"BusinessProfile",id:"businessprofile",level:3},{value:"CLOUD_PROVIDERS",id:"cloud_providers",level:3},{value:"Call",id:"call",level:3},{value:"CallState",id:"callstate",level:3},{value:"CartItem",id:"cartitem",level:3},{value:"Chat",id:"chat",level:3},{value:"ChatId",id:"chatid",level:3},{value:"ChatMuteDuration",id:"chatmuteduration",level:3},{value:"ChatServer",id:"chatserver",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ChatTypes",id:"chattypes",level:3},{value:"ConfigObject",id:"configobject",level:3},{value:"Contact",id:"contact",level:3},{value:"ContactId",id:"contactid",level:3},{value:"Content",id:"content",level:3},{value:"CountryCode",id:"countrycode",level:3},{value:"CustomError",id:"customerror",level:3},{value:"CustomProduct",id:"customproduct",level:3},{value:"DIRECTORY_STRATEGY",id:"directory_strategy",level:3},{value:"DataURL",id:"dataurl",level:3},{value:"DevTools",id:"devtools",level:3},{value:"ERROR_NAME",id:"error_name",level:3},{value:"EphemeralDuration",id:"ephemeralduration",level:3},{value:"EventPayload",id:"eventpayload",level:3},{value:"FilePath",id:"filepath",level:3},{value:"GetURL",id:"geturl",level:3},{value:"GroupChat",id:"groupchat",level:3},{value:"GroupChatCreationParticipantAddResponse",id:"groupchatcreationparticipantaddresponse",level:3},{value:"GroupChatCreationResponse",id:"groupchatcreationresponse",level:3},{value:"GroupChatId",id:"groupchatid",level:3},{value:"GroupChatServer",id:"groupchatserver",level:3},{value:"GroupId",id:"groupid",level:3},{value:"Label",id:"label",level:3},{value:"LicenseType",id:"licensetype",level:3},{value:"LiveLocationChangedEvent",id:"livelocationchangedevent",level:3},{value:"Message",id:"message",level:3},{value:"MessageAck",id:"messageack",level:3},{value:"MessageId",id:"messageid",level:3},{value:"MessageInfo",id:"messageinfo",level:3},{value:"MessageInfoInteraction",id:"messageinfointeraction",level:3},{value:"MessageTypes",id:"messagetypes",level:3},{value:"Mp4StickerConversionProcessOptions",id:"mp4stickerconversionprocessoptions",level:3},{value:"NonSerializedId",id:"nonserializedid",level:3},{value:"NotificationLanguage",id:"notificationlanguage",level:3},{value:"NumberCheck",id:"numbercheck",level:3},{value:"OnError",id:"onerror",level:3},{value:"Order",id:"order",level:3},{value:"PageEvaluationTimeout",id:"pageevaluationtimeout",level:3},{value:"PollData",id:"polldata",level:3},{value:"PollOption",id:"polloption",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Product",id:"product",level:3},{value:"ProxyServerCredentials",id:"proxyservercredentials",level:3},{value:"QRFormat",id:"qrformat",level:3},{value:"QRQuality",id:"qrquality",level:3},{value:"QuoteMap",id:"quotemap",level:3},{value:"Reaction",id:"reaction",level:3},{value:"ReactionEvent",id:"reactionevent",level:3},{value:"ReactionRecord",id:"reactionrecord",level:3},{value:"ReactionSender",id:"reactionsender",level:3},{value:"SessionData",id:"sessiondata",level:3},{value:"SessionExpiredError",id:"sessionexpirederror",level:3},{value:"SimpleListener",id:"simplelistener",level:3},{value:"SingleChat",id:"singlechat",level:3},{value:"StickerMetadata",id:"stickermetadata",level:3},{value:"WaServers",id:"waservers",level:3},{value:"Webhook",id:"webhook",level:3},{value:"defaultProcessOptions",id:"defaultprocessoptions",level:3}];function t(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"apimodel",children:"api/model"}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Events",children:"Events"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/STATE",children:"STATE"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Status",children:"Status"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/type-aliases/EasyApiResponse",children:"EasyApiResponse"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"references",children:"References"}),"\n",(0,n.jsx)(r.h3,{id:"accountnumber",children:"AccountNumber"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterror",children:"AddParticipantError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterrorstatuscode",children:"AddParticipantErrorStatusCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedconfig",children:"AdvancedConfig"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedfile",children:"AdvancedFile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"base64",children:"Base64"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"basechat",children:"BaseChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizcategory",children:"BizCategory"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizprofileoptions",children:"BizProfileOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businesshours",children:"BusinessHours"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businessprofile",children:"BusinessProfile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cloud_providers",children:"CLOUD_PROVIDERS"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"Call"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"callstate",children:"CallState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cartitem",children:"CartItem"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chat",children:"Chat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatid",children:"ChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatmuteduration",children:"ChatMuteDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatserver",children:"ChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chattypes",children:"ChatTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"configobject",children:"ConfigObject"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contact",children:"Contact"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contactid",children:"ContactId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"content",children:"Content"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"countrycode",children:"CountryCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customerror",children:"CustomError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customproduct",children:"CustomProduct"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"directory_strategy",children:"DIRECTORY_STRATEGY"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"dataurl",children:"DataURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"devtools",children:"DevTools"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"error_name",children:"ERROR_NAME"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ephemeralduration",children:"EphemeralDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"eventpayload",children:"EventPayload"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"filepath",children:"FilePath"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"geturl",children:"GetURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchat",children:"GroupChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationparticipantaddresponse",children:"GroupChatCreationParticipantAddResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationresponse",children:"GroupChatCreationResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatid",children:"GroupChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatserver",children:"GroupChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupid",children:"GroupId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"Label"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"licensetype",children:"LicenseType"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"livelocationchangedevent",children:"LiveLocationChangedEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"Message"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageack",children:"MessageAck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageid",children:"MessageId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfo",children:"MessageInfo"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfointeraction",children:"MessageInfoInteraction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messagetypes",children:"MessageTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"mp4stickerconversionprocessoptions",children:"Mp4StickerConversionProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"nonserializedid",children:"NonSerializedId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"notificationlanguage",children:"NotificationLanguage"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"numbercheck",children:"NumberCheck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"onerror",children:"OnError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"order",children:"Order"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pageevaluationtimeout",children:"PageEvaluationTimeout"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polldata",children:"PollData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polloption",children:"PollOption"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"product",children:"Product"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"proxyservercredentials",children:"ProxyServerCredentials"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrformat",children:"QRFormat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrquality",children:"QRQuality"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"quotemap",children:"QuoteMap"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reaction",children:"Reaction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionevent",children:"ReactionEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionrecord",children:"ReactionRecord"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionsender",children:"ReactionSender"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessiondata",children:"SessionData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessionexpirederror",children:"SessionExpiredError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"simplelistener",children:"SimpleListener"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"singlechat",children:"SingleChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stickermetadata",children:"StickerMetadata"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"waservers",children:"WaServers"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"webhook",children:"Webhook"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"defaultprocessoptions",children:"defaultProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})]})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(t,{...e})}):t(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>d});var n=s(6540);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/745741e5.28a9c9ef.js b/assets/js/745741e5.28a9c9ef.js deleted file mode 100644 index 9e7e40d327..0000000000 --- a/assets/js/745741e5.28a9c9ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1121],{1214:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=n(4848),i=n(8453);const t={},d="Interface: Id",c={id:"reference/api/model/id/interfaces/Id",title:"Interface: Id",description:"Properties",source:"@site/docs/reference/api/model/id/interfaces/Id.md",sourceDirName:"reference/api/model/id/interfaces",slug:"/reference/api/model/id/interfaces/Id",permalink:"/docs/reference/api/model/id/interfaces/Id",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/id/interfaces/Id.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/id",permalink:"/docs/reference/api/model/id/"},next:{title:"api/model/label",permalink:"/docs/reference/api/model/label/"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"_serialized",id:"_serialized",level:3},{value:"server",id:"server",level:3},{value:"user",id:"user",level:3}];function a(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"interface-id",children:"Interface: Id"}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"_serialized",children:"_serialized"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"_serialized"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"server",children:"server"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"server"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"user",children:"user"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"user"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>c});var s=n(6540);const i={},t=s.createContext(i);function d(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/745741e5.2d19b10b.js b/assets/js/745741e5.2d19b10b.js new file mode 100644 index 0000000000..c6025c4481 --- /dev/null +++ b/assets/js/745741e5.2d19b10b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1121],{1214:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=n(4848),i=n(8453);const t={},d="Interface: Id",c={id:"reference/api/model/id/interfaces/Id",title:"Interface: Id",description:"Properties",source:"@site/docs/reference/api/model/id/interfaces/Id.md",sourceDirName:"reference/api/model/id/interfaces",slug:"/reference/api/model/id/interfaces/Id",permalink:"/docs/reference/api/model/id/interfaces/Id",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/id/interfaces/Id.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/id",permalink:"/docs/reference/api/model/id/"},next:{title:"api/model/label",permalink:"/docs/reference/api/model/label/"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"_serialized",id:"_serialized",level:3},{value:"server",id:"server",level:3},{value:"user",id:"user",level:3}];function a(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"interface-id",children:"Interface: Id"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"_serialized",children:"_serialized"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"_serialized"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"server",children:"server"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"server"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"user",children:"user"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"user"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>c});var s=n(6540);const i={},t=s.createContext(i);function d(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7628d2f1.5747a848.js b/assets/js/7628d2f1.5747a848.js deleted file mode 100644 index 39a37d0e3a..0000000000 --- a/assets/js/7628d2f1.5747a848.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6067],{5468:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=t(4848),s=t(8453);const a={},c="Enumeration: namespace",o={id:"reference/api/Client/enumerations/namespace",title:"Enumeration: namespace",description:"Enumeration Members",source:"@site/docs/reference/api/Client/enumerations/namespace.md",sourceDirName:"reference/api/Client/enumerations",slug:"/reference/api/Client/enumerations/namespace",permalink:"/docs/reference/api/Client/enumerations/namespace",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/enumerations/namespace.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"},next:{title:"Variable: useragent",permalink:"/docs/reference/api/Client/variables/useragent"}},i={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Chat",id:"chat",level:3},{value:"Contact",id:"contact",level:3},{value:"GroupMetadata",id:"groupmetadata",level:3},{value:"Msg",id:"msg",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-namespace",children:"Enumeration: namespace"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"chat",children:"Chat"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Chat"}),": ",(0,r.jsx)(n.code,{children:'"Chat"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact",children:"Contact"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Contact"}),": ",(0,r.jsx)(n.code,{children:'"Contact"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupmetadata",children:"GroupMetadata"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupMetadata"}),": ",(0,r.jsx)(n.code,{children:'"GroupMetadata"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msg",children:"Msg"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Msg"}),": ",(0,r.jsx)(n.code,{children:'"Msg"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7628d2f1.6ea6096a.js b/assets/js/7628d2f1.6ea6096a.js new file mode 100644 index 0000000000..ed8f870f29 --- /dev/null +++ b/assets/js/7628d2f1.6ea6096a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6067],{5468:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=t(4848),s=t(8453);const a={},c="Enumeration: namespace",o={id:"reference/api/Client/enumerations/namespace",title:"Enumeration: namespace",description:"Enumeration Members",source:"@site/docs/reference/api/Client/enumerations/namespace.md",sourceDirName:"reference/api/Client/enumerations",slug:"/reference/api/Client/enumerations/namespace",permalink:"/docs/reference/api/Client/enumerations/namespace",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/enumerations/namespace.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"},next:{title:"Variable: useragent",permalink:"/docs/reference/api/Client/variables/useragent"}},i={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Chat",id:"chat",level:3},{value:"Contact",id:"contact",level:3},{value:"GroupMetadata",id:"groupmetadata",level:3},{value:"Msg",id:"msg",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-namespace",children:"Enumeration: namespace"})}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"chat",children:"Chat"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Chat"}),": ",(0,r.jsx)(n.code,{children:'"Chat"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contact",children:"Contact"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Contact"}),": ",(0,r.jsx)(n.code,{children:'"Contact"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupmetadata",children:"GroupMetadata"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupMetadata"}),": ",(0,r.jsx)(n.code,{children:'"GroupMetadata"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msg",children:"Msg"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Msg"}),": ",(0,r.jsx)(n.code,{children:'"Msg"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7661071f.0c27915b.js b/assets/js/7661071f.0c27915b.js new file mode 100644 index 0000000000..dd04e68c5f --- /dev/null +++ b/assets/js/7661071f.0c27915b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8737],{4137:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>l,metadata:()=>a,toc:()=>i});var n=s(4848),t=s(8453);const l={slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},r=void 0,a={permalink:"/blog/welcome",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md",source:"@site/blog/2021-08-26-welcome/index.md",title:"Welcome",description:"Docusaurus blogging features are powered by the blog plugin.",date:"2021-08-26T00:00:00.000Z",tags:[{inline:!1,label:"Facebook",permalink:"/blog/tags/facebook",description:"Facebook tag description"},{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.405,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber",page:null},{name:"Yangshun Tay",title:"Front End Engineer @ Facebook",url:"https://github.com/yangshun",imageURL:"https://github.com/yangshun.png",key:"yangshun",page:null}],frontMatter:{slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},unlisted:!1,nextItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"}},c={authorsImageUrls:[void 0,void 0]},i=[];function u(e){const o={a:"a",code:"code",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/blog",children:"Docusaurus blogging features"})," are powered by the ",(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog",children:"blog plugin"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["Simply add Markdown files (or folders) to the ",(0,n.jsx)(o.code,{children:"blog"})," directory."]}),"\n",(0,n.jsxs)(o.p,{children:["Regular blog authors can be added to ",(0,n.jsx)(o.code,{children:"authors.yml"}),"."]}),"\n",(0,n.jsx)(o.p,{children:"The blog post date can be extracted from filenames, such as:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome.md"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome/index.md"})}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"A blog post folder can be convenient to co-locate blog post images:"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"Docusaurus Plushie",src:s(575).A+"",width:"1500",height:"500"})}),"\n",(0,n.jsx)(o.p,{children:"The blog supports tags as well!"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"And if you don't want a blog"}),": just delete this directory, and use ",(0,n.jsx)(o.code,{children:"blog: false"})," in your Docusaurus config."]})]})}function d(e={}){const{wrapper:o}={...(0,t.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},575:(e,o,s)=>{s.d(o,{A:()=>n});const n=s.p+"assets/images/docusaurus-plushie-banner-a60f7593abca1e3eef26a9afa244e4fb.jpeg"},8453:(e,o,s)=>{s.d(o,{R:()=>r,x:()=>a});var n=s(6540);const t={},l=n.createContext(t);function r(e){const o=n.useContext(l);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(l.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7661071f.209ee5e2.js b/assets/js/7661071f.209ee5e2.js deleted file mode 100644 index 545368b0a1..0000000000 --- a/assets/js/7661071f.209ee5e2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8737],{4137:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>i});var n=s(4848),t=s(8453);const r={slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},l=void 0,a={permalink:"/blog/welcome",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md",source:"@site/blog/2021-08-26-welcome/index.md",title:"Welcome",description:"Docusaurus blogging features are powered by the blog plugin.",date:"2021-08-26T00:00:00.000Z",tags:[{inline:!1,label:"Facebook",permalink:"/blog/tags/facebook",description:"Facebook tag description"},{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.405,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber"},{name:"Yangshun Tay",title:"Front End Engineer @ Facebook",url:"https://github.com/yangshun",imageURL:"https://github.com/yangshun.png",key:"yangshun"}],frontMatter:{slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},unlisted:!1,nextItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"}},c={authorsImageUrls:[void 0,void 0]},i=[];function u(e){const o={a:"a",code:"code",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/blog",children:"Docusaurus blogging features"})," are powered by the ",(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog",children:"blog plugin"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["Simply add Markdown files (or folders) to the ",(0,n.jsx)(o.code,{children:"blog"})," directory."]}),"\n",(0,n.jsxs)(o.p,{children:["Regular blog authors can be added to ",(0,n.jsx)(o.code,{children:"authors.yml"}),"."]}),"\n",(0,n.jsx)(o.p,{children:"The blog post date can be extracted from filenames, such as:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome.md"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome/index.md"})}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"A blog post folder can be convenient to co-locate blog post images:"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"Docusaurus Plushie",src:s(575).A+"",width:"1500",height:"500"})}),"\n",(0,n.jsx)(o.p,{children:"The blog supports tags as well!"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"And if you don't want a blog"}),": just delete this directory, and use ",(0,n.jsx)(o.code,{children:"blog: false"})," in your Docusaurus config."]})]})}function d(e={}){const{wrapper:o}={...(0,t.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},575:(e,o,s)=>{s.d(o,{A:()=>n});const n=s.p+"assets/images/docusaurus-plushie-banner-a60f7593abca1e3eef26a9afa244e4fb.jpeg"},8453:(e,o,s)=>{s.d(o,{R:()=>l,x:()=>a});var n=s(6540);const t={},r=n.createContext(t);function l(e){const o=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7803af04.59242b76.js b/assets/js/7803af04.59242b76.js new file mode 100644 index 0000000000..4d4cc5464d --- /dev/null +++ b/assets/js/7803af04.59242b76.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1536],{3958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>l,toc:()=>t});var r=s(4848),i=s(8453);const o={},c="Interface: SessionInfo",l={id:"reference/api/model/sessionInfo/interfaces/SessionInfo",title:"Interface: SessionInfo",description:"Properties",source:"@site/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",sourceDirName:"reference/api/model/sessionInfo/interfaces",slug:"/reference/api/model/sessionInfo/interfaces/SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck"},next:{title:"Type Alias: EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse"}},d={},t=[{value:"Properties",id:"properties",level:2},{value:"ACC_TYPE?",id:"acc_type",level:3},{value:"BROWSER_VERSION",id:"browser_version",level:3},{value:"CLI?",id:"cli",level:3},{value:"INSTANCE_ID?",id:"instance_id",level:3},{value:"LATEST_VERSION?",id:"latest_version",level:3},{value:"LAUNCH_TIME_MS?",id:"launch_time_ms",level:3},{value:"NUM?",id:"num",level:3},{value:"NUM_HASH?",id:"num_hash",level:3},{value:"OS?",id:"os",level:3},{value:"OW_KEY?",id:"ow_key",level:3},{value:"PAGE_UA",id:"page_ua",level:3},{value:"PATCH_HASH?",id:"patch_hash",level:3},{value:"PHONE_VERSION?",id:"phone_version",level:3},{value:"PPTR_VERSION?",id:"pptr_version",level:3},{value:"RAM_INFO?",id:"ram_info",level:3},{value:"START_TS?",id:"start_ts",level:3},{value:"WA_AUTOMATE_VERSION",id:"wa_automate_version",level:3},{value:"WA_VERSION",id:"wa_version",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-sessioninfo",children:"Interface: SessionInfo"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"acc_type",children:"ACC_TYPE?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ACC_TYPE"}),": ",(0,r.jsx)(n.code,{children:'"PERSONAL"'})," | ",(0,r.jsx)(n.code,{children:'"BUSINESS"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"browser_version",children:"BROWSER_VERSION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"BROWSER_VERSION"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cli",children:"CLI?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"CLI"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"instance_id",children:"INSTANCE_ID?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"INSTANCE_ID"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"latest_version",children:"LATEST_VERSION?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"LATEST_VERSION"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"launch_time_ms",children:"LAUNCH_TIME_MS?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"LAUNCH_TIME_MS"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"num",children:"NUM?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"NUM"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"num_hash",children:"NUM_HASH?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"NUM_HASH"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"os",children:"OS?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"OS"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ow_key",children:"OW_KEY?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"OW_KEY"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"page_ua",children:"PAGE_UA"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PAGE_UA"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"patch_hash",children:"PATCH_HASH?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"PATCH_HASH"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"phone_version",children:"PHONE_VERSION?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"PHONE_VERSION"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pptr_version",children:"PPTR_VERSION?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"PPTR_VERSION"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ram_info",children:"RAM_INFO?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"RAM_INFO"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"start_ts",children:"START_TS?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"START_TS"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"wa_automate_version",children:"WA_AUTOMATE_VERSION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"WA_AUTOMATE_VERSION"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"wa_version",children:"WA_VERSION"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"WA_VERSION"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function x(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>l});var r=s(6540);const i={},o=r.createContext(i);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7803af04.f06c755d.js b/assets/js/7803af04.f06c755d.js deleted file mode 100644 index 95bf13a827..0000000000 --- a/assets/js/7803af04.f06c755d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1536],{3958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>l,toc:()=>t});var i=s(4848),r=s(8453);const o={},c="Interface: SessionInfo",l={id:"reference/api/model/sessionInfo/interfaces/SessionInfo",title:"Interface: SessionInfo",description:"Properties",source:"@site/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",sourceDirName:"reference/api/model/sessionInfo/interfaces",slug:"/reference/api/model/sessionInfo/interfaces/SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck"},next:{title:"Type Alias: EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse"}},d={},t=[{value:"Properties",id:"properties",level:2},{value:"ACC_TYPE?",id:"acc_type",level:3},{value:"BROWSER_VERSION",id:"browser_version",level:3},{value:"CLI?",id:"cli",level:3},{value:"INSTANCE_ID?",id:"instance_id",level:3},{value:"LATEST_VERSION?",id:"latest_version",level:3},{value:"LAUNCH_TIME_MS?",id:"launch_time_ms",level:3},{value:"NUM?",id:"num",level:3},{value:"NUM_HASH?",id:"num_hash",level:3},{value:"OS?",id:"os",level:3},{value:"OW_KEY?",id:"ow_key",level:3},{value:"PAGE_UA",id:"page_ua",level:3},{value:"PATCH_HASH?",id:"patch_hash",level:3},{value:"PHONE_VERSION?",id:"phone_version",level:3},{value:"PPTR_VERSION?",id:"pptr_version",level:3},{value:"RAM_INFO?",id:"ram_info",level:3},{value:"START_TS?",id:"start_ts",level:3},{value:"WA_AUTOMATE_VERSION",id:"wa_automate_version",level:3},{value:"WA_VERSION",id:"wa_version",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-sessioninfo",children:"Interface: SessionInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"acc_type",children:"ACC_TYPE?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ACC_TYPE"}),": ",(0,i.jsx)(n.code,{children:'"PERSONAL"'})," | ",(0,i.jsx)(n.code,{children:'"BUSINESS"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"browser_version",children:"BROWSER_VERSION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"BROWSER_VERSION"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cli",children:"CLI?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CLI"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"instance_id",children:"INSTANCE_ID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"INSTANCE_ID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"latest_version",children:"LATEST_VERSION?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LATEST_VERSION"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"launch_time_ms",children:"LAUNCH_TIME_MS?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LAUNCH_TIME_MS"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"num",children:"NUM?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NUM"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"num_hash",children:"NUM_HASH?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NUM_HASH"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"os",children:"OS?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OS"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ow_key",children:"OW_KEY?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OW_KEY"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"page_ua",children:"PAGE_UA"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"PAGE_UA"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"patch_hash",children:"PATCH_HASH?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PATCH_HASH"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"phone_version",children:"PHONE_VERSION?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PHONE_VERSION"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pptr_version",children:"PPTR_VERSION?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PPTR_VERSION"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ram_info",children:"RAM_INFO?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"RAM_INFO"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"start_ts",children:"START_TS?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"START_TS"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"wa_automate_version",children:"WA_AUTOMATE_VERSION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WA_AUTOMATE_VERSION"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"wa_version",children:"WA_VERSION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WA_VERSION"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>l});var i=s(6540);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/792432d4.a232f1e4.js b/assets/js/792432d4.a232f1e4.js deleted file mode 100644 index a4cf1eb7e4..0000000000 --- a/assets/js/792432d4.a232f1e4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2426],{9341:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>n,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var t=r(4848),o=r(8453);const a={},n="Type Alias: GroupId",i={id:"reference/api/model/aliases/type-aliases/GroupId",title:"Type Alias: GroupId",description:"GroupId: \\$\\{number\\}@$\\{GroupChatServer\\}\\",source:"@site/docs/reference/api/model/aliases/type-aliases/GroupId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer"},next:{title:"Type Alias: MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId"}},c={},l=[];function p(e){const s={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"type-alias-groupid",children:"Type Alias: GroupId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"GroupId"}),": `${number}@${GroupChatServer}`"]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["A new group or community has the format of a random number followed by ",(0,t.jsx)(s.code,{children:"@g.us"})]})]})}function d(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>i});var t=r(6540);const o={},a=t.createContext(o);function n(e){const s=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:n(e.components),t.createElement(a.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/792432d4.a3d18f27.js b/assets/js/792432d4.a3d18f27.js new file mode 100644 index 0000000000..d0bbd31203 --- /dev/null +++ b/assets/js/792432d4.a3d18f27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2426],{9341:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>n,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var t=s(4848),a=s(8453);const o={},n="Type Alias: GroupId",i={id:"reference/api/model/aliases/type-aliases/GroupId",title:"Type Alias: GroupId",description:"GroupId: \\$\\{number\\}@$\\{GroupChatServer\\}\\",source:"@site/docs/reference/api/model/aliases/type-aliases/GroupId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer"},next:{title:"Type Alias: MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId"}},c={},d=[];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"type-alias-groupid",children:"Type Alias: GroupId"})}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"GroupId"}),": `${number}@${GroupChatServer}`"]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["A new group or community has the format of a random number followed by ",(0,t.jsx)(r.code,{children:"@g.us"})]})]})}function p(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>n,x:()=>i});var t=s(6540);const a={},o=t.createContext(a);function n(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/79bb96de.6d540f7c.js b/assets/js/79bb96de.6d540f7c.js deleted file mode 100644 index 90b2b4908f..0000000000 --- a/assets/js/79bb96de.6d540f7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6851],{4868:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>a,default:()=>g,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=n(4848),o=n(8453);const i={},a="Receiving Messages",c={id:"how-to/receive-messages",title:"Receiving Messages",description:"Listen to only incoming messages",source:"@site/docs/how-to/receive-messages.md",sourceDirName:"how-to",slug:"/how-to/receive-messages",permalink:"/docs/how-to/receive-messages",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/receive-messages.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"receive-files",permalink:"/docs/how-to/receive-files"},next:{title:"Sending Files",permalink:"/docs/how-to/send-files"}},r={},l=[{value:"Listen to only incoming messages",id:"listen-to-only-incoming-messages",level:2},{value:"Listen to all messages in and out",id:"listen-to-all-messages-in-and-out",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"receiving-messages",children:"Receiving Messages"}),"\n",(0,t.jsx)(s.h2,{id:"listen-to-only-incoming-messages",children:"Listen to only incoming messages"}),"\n",(0,t.jsx)(s.p,{children:"[[onMessage]]"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-javascript",children:" client.onMessage(message=>{\n console.log(message.body);\n })\n"})}),"\n",(0,t.jsx)(s.h2,{id:"listen-to-all-messages-in-and-out",children:"Listen to all messages in and out"}),"\n",(0,t.jsx)(s.p,{children:"[[onAnyMessage]]"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-javascript",children:" client.onAnyMessage(message=>{\n console.log(message.body);\n })\n"})})]})}function g(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>c});var t=n(6540);const o={},i=t.createContext(o);function a(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/79bb96de.a40a46d6.js b/assets/js/79bb96de.a40a46d6.js new file mode 100644 index 0000000000..7e12dd648b --- /dev/null +++ b/assets/js/79bb96de.a40a46d6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6851],{4868:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>a,default:()=>g,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=n(4848),o=n(8453);const i={},a="Receiving Messages",c={id:"how-to/receive-messages",title:"Receiving Messages",description:"Listen to only incoming messages",source:"@site/docs/how-to/receive-messages.md",sourceDirName:"how-to",slug:"/how-to/receive-messages",permalink:"/docs/how-to/receive-messages",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/receive-messages.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"receive-files",permalink:"/docs/how-to/receive-files"},next:{title:"Sending Files",permalink:"/docs/how-to/send-files"}},r={},l=[{value:"Listen to only incoming messages",id:"listen-to-only-incoming-messages",level:2},{value:"Listen to all messages in and out",id:"listen-to-all-messages-in-and-out",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"receiving-messages",children:"Receiving Messages"})}),"\n",(0,t.jsx)(s.h2,{id:"listen-to-only-incoming-messages",children:"Listen to only incoming messages"}),"\n",(0,t.jsx)(s.p,{children:"[[onMessage]]"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-javascript",children:" client.onMessage(message=>{\n console.log(message.body);\n })\n"})}),"\n",(0,t.jsx)(s.h2,{id:"listen-to-all-messages-in-and-out",children:"Listen to all messages in and out"}),"\n",(0,t.jsx)(s.p,{children:"[[onAnyMessage]]"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-javascript",children:" client.onAnyMessage(message=>{\n console.log(message.body);\n })\n"})})]})}function g(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>c});var t=n(6540);const o={},i=t.createContext(o);function a(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c769d76.d00e3472.js b/assets/js/7c769d76.d00e3472.js deleted file mode 100644 index eb515a31ed..0000000000 --- a/assets/js/7c769d76.d00e3472.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8726],{4662:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var n=o(4848),s=o(8453);const c={},a="Detecting Logouts",r={id:"how-to/detect-logout",title:"Detecting Logouts",description:"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.",source:"@site/docs/how-to/detect-logout.md",sourceDirName:"how-to",slug:"/how-to/detect-logout",permalink:"/docs/how-to/detect-logout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/detect-logout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Decrypting Media",permalink:"/docs/how-to/decrypt-media"},next:{title:"Group",permalink:"/docs/how-to/groups"}},i={},u=[];function d(e){const t={code:"code",h1:"h1",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"detecting-logouts",children:"Detecting Logouts"}),"\n",(0,n.jsxs)(t.p,{children:["First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If ",(0,n.jsx)(t.code,{children:"state"})," equals ",(0,n.jsx)(t.code,{children:"UNPAIRED"})," that means the host account user has manually de authenticated the session through the app."]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-javascript",children:"\n client.onStateChanged(state=>{\n console.log('statechanged', state)\n if(state===\"CONFLICT\" || state===\"UNLAUNCHED\") client.forceRefocus();\n\n if(state==='UNPAIRED') console.log('LOGGED OUT!!!!')\n });\n"})}),"\n",(0,n.jsx)(t.p,{children:"For more information see: [[STATE]]"})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>a,x:()=>r});var n=o(6540);const s={},c=n.createContext(s);function a(e){const t=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c769d76.eb690d6c.js b/assets/js/7c769d76.eb690d6c.js new file mode 100644 index 0000000000..7f7056a82c --- /dev/null +++ b/assets/js/7c769d76.eb690d6c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8726],{4662:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var n=o(4848),s=o(8453);const c={},a="Detecting Logouts",r={id:"how-to/detect-logout",title:"Detecting Logouts",description:"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.",source:"@site/docs/how-to/detect-logout.md",sourceDirName:"how-to",slug:"/how-to/detect-logout",permalink:"/docs/how-to/detect-logout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/detect-logout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Decrypting Media",permalink:"/docs/how-to/decrypt-media"},next:{title:"Group",permalink:"/docs/how-to/groups"}},i={},u=[];function d(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"detecting-logouts",children:"Detecting Logouts"})}),"\n",(0,n.jsxs)(t.p,{children:["First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If ",(0,n.jsx)(t.code,{children:"state"})," equals ",(0,n.jsx)(t.code,{children:"UNPAIRED"})," that means the host account user has manually de authenticated the session through the app."]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-javascript",children:"\n client.onStateChanged(state=>{\n console.log('statechanged', state)\n if(state===\"CONFLICT\" || state===\"UNLAUNCHED\") client.forceRefocus();\n\n if(state==='UNPAIRED') console.log('LOGGED OUT!!!!')\n });\n"})}),"\n",(0,n.jsx)(t.p,{children:"For more information see: [[STATE]]"})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>a,x:()=>r});var n=o(6540);const s={},c=n.createContext(s);function a(e){const t=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d55d1f2.352f6aa2.js b/assets/js/7d55d1f2.352f6aa2.js new file mode 100644 index 0000000000..9c1a6215a5 --- /dev/null +++ b/assets/js/7d55d1f2.352f6aa2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7157],{7342:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var t=r(4848),s=r(8453);const i={},l="Interface: Label",a={id:"reference/api/model/label/interfaces/Label",title:"Interface: Label",description:"Properties",source:"@site/docs/reference/api/model/label/interfaces/Label.md",sourceDirName:"reference/api/model/label/interfaces",slug:"/reference/api/model/label/interfaces/Label",permalink:"/docs/reference/api/model/label/interfaces/Label",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/label/interfaces/Label.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/label",permalink:"/docs/reference/api/model/label/"},next:{title:"api/model/media",permalink:"/docs/reference/api/model/media/"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"items",id:"items",level:3},{value:"name",id:"name",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-label",children:"Interface: Label"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:'The internal ID of the label. Usually a number represented as a string e.g "1"'}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"items"}),": ",(0,t.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The items that are tagged with this label"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The text contents of the label"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var t=r(6540);const s={},i=t.createContext(s);function l(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d55d1f2.ccfc5ce3.js b/assets/js/7d55d1f2.ccfc5ce3.js deleted file mode 100644 index 9300331a0a..0000000000 --- a/assets/js/7d55d1f2.ccfc5ce3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7157],{7342:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var r=t(4848),s=t(8453);const i={},l="Interface: Label",a={id:"reference/api/model/label/interfaces/Label",title:"Interface: Label",description:"Properties",source:"@site/docs/reference/api/model/label/interfaces/Label.md",sourceDirName:"reference/api/model/label/interfaces",slug:"/reference/api/model/label/interfaces/Label",permalink:"/docs/reference/api/model/label/interfaces/Label",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/label/interfaces/Label.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/label",permalink:"/docs/reference/api/model/label/"},next:{title:"api/model/media",permalink:"/docs/reference/api/model/media/"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"items",id:"items",level:3},{value:"name",id:"name",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-label",children:"Interface: Label"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:'The internal ID of the label. Usually a number represented as a string e.g "1"'}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"items"}),": ",(0,r.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The items that are tagged with this label"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text contents of the label"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function l(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e283186.b17b125c.js b/assets/js/7e283186.b17b125c.js deleted file mode 100644 index 8b779edfc9..0000000000 --- a/assets/js/7e283186.b17b125c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2119],{1040:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var n=s(4848),t=s(8453);const i={},c="Interface: DialogTemplate",l={id:"reference/structures/Dialog/interfaces/DialogTemplate",title:"Interface: DialogTemplate",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState"},next:{title:"Interface: DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"dialogId",id:"dialogid",level:3},{value:"identifier",id:"identifier",level:3},{value:"privateOnly",id:"privateonly",level:3},{value:"properties",id:"properties-1",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"startMessage",id:"startmessage",level:3},{value:"successMessage",id:"successmessage",level:3}];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-dialogtemplate",children:"Interface: DialogTemplate"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"dialogid",children:"dialogId"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"dialogId"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"identifier",children:"identifier"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"identifier"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"privateonly",children:"privateOnly"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"privateOnly"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"properties-1",children:"properties"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"properties"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,n.jsxs)(r.p,{children:["[",(0,n.jsx)(r.code,{children:"key"}),": ",(0,n.jsx)(r.code,{children:"string"}),"]: ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogProperty",children:(0,n.jsx)(r.code,{children:"DialogProperty"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"startmessage",children:"startMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"startMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"successmessage",children:"successMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"successMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>l});var n=s(6540);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e283186.b751a54a.js b/assets/js/7e283186.b751a54a.js new file mode 100644 index 0000000000..49c5960424 --- /dev/null +++ b/assets/js/7e283186.b751a54a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2119],{1040:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var n=s(4848),t=s(8453);const i={},c="Interface: DialogTemplate",l={id:"reference/structures/Dialog/interfaces/DialogTemplate",title:"Interface: DialogTemplate",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState"},next:{title:"Interface: DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"dialogId",id:"dialogid",level:3},{value:"identifier",id:"identifier",level:3},{value:"privateOnly",id:"privateonly",level:3},{value:"properties",id:"properties-1",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"startMessage",id:"startmessage",level:3},{value:"successMessage",id:"successmessage",level:3}];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-dialogtemplate",children:"Interface: DialogTemplate"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"dialogid",children:"dialogId"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"dialogId"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"identifier",children:"identifier"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"identifier"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"privateonly",children:"privateOnly"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"privateOnly"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"properties-1",children:"properties"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"properties"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,n.jsxs)(r.p,{children:["[",(0,n.jsx)(r.code,{children:"key"}),": ",(0,n.jsx)(r.code,{children:"string"}),"]: ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogProperty",children:(0,n.jsx)(r.code,{children:"DialogProperty"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"startmessage",children:"startMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"startMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"successmessage",children:"successMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"successMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>l});var n=s(6540);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/80965edc.7ac73897.js b/assets/js/80965edc.7ac73897.js new file mode 100644 index 0000000000..a8cacf4d3b --- /dev/null +++ b/assets/js/80965edc.7ac73897.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6555],{6794:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>i,contentTitle:()=>n,default:()=>d,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(4848),l=s(8453);const c={},n="structures/Collector",o={id:"reference/structures/Collector/index",title:"structures/Collector",description:"Index",source:"@site/docs/reference/structures/Collector/index.md",sourceDirName:"reference/structures/Collector",slug:"/reference/structures/Collector/",permalink:"/docs/reference/structures/Collector/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: log",permalink:"/docs/reference/logging/logging/variables/log"},next:{title:"Class: Collection\\",permalink:"/docs/reference/structures/Collector/classes/Collection"}},i={},a=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function u(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"structurescollector",children:"structures/Collector"})}),"\n",(0,t.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(r.h3,{id:"classes",children:"Classes"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:"Collection"})}),"\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:"Collector"})}),"\n"]}),"\n",(0,t.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:"AwaitMessagesOptions"})}),"\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:"CollectorOptions"})}),"\n"]}),"\n",(0,t.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:"CollectorFilter"})}),"\n"]})]})}function d(e={}){const{wrapper:r}={...(0,l.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>n,x:()=>o});var t=s(6540);const l={},c=t.createContext(l);function n(e){const r=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),t.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/80965edc.f2c2a209.js b/assets/js/80965edc.f2c2a209.js deleted file mode 100644 index f3e5827f8e..0000000000 --- a/assets/js/80965edc.f2c2a209.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6555],{6794:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>i,contentTitle:()=>n,default:()=>d,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(4848),l=s(8453);const c={},n="structures/Collector",o={id:"reference/structures/Collector/index",title:"structures/Collector",description:"Index",source:"@site/docs/reference/structures/Collector/index.md",sourceDirName:"reference/structures/Collector",slug:"/reference/structures/Collector/",permalink:"/docs/reference/structures/Collector/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: log",permalink:"/docs/reference/logging/logging/variables/log"},next:{title:"Class: Collection\\",permalink:"/docs/reference/structures/Collector/classes/Collection"}},i={},a=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function u(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"structurescollector",children:"structures/Collector"}),"\n",(0,t.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(r.h3,{id:"classes",children:"Classes"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:"Collection"})}),"\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:"Collector"})}),"\n"]}),"\n",(0,t.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:"AwaitMessagesOptions"})}),"\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:"CollectorOptions"})}),"\n"]}),"\n",(0,t.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:(0,t.jsx)(r.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:"CollectorFilter"})}),"\n"]})]})}function d(e={}){const{wrapper:r}={...(0,l.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>n,x:()=>o});var t=s(6540);const l={},c=t.createContext(l);function n(e){const r=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),t.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814f3328.5dfaceaf.js b/assets/js/814f3328.5dfaceaf.js deleted file mode 100644 index 6e1fb507e7..0000000000 --- a/assets/js/814f3328.5dfaceaf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7472],{5513:l=>{l.exports=JSON.parse('{"title":"Recent posts","items":[{"title":"Welcome","permalink":"/blog/welcome","unlisted":false},{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post","unlisted":false},{"title":"Long Blog Post","permalink":"/blog/long-blog-post","unlisted":false},{"title":"First Blog Post","permalink":"/blog/first-blog-post","unlisted":false}]}')}}]); \ No newline at end of file diff --git a/assets/js/814f3328.c006fd3d.js b/assets/js/814f3328.c006fd3d.js new file mode 100644 index 0000000000..388da87595 --- /dev/null +++ b/assets/js/814f3328.c006fd3d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7472],{5513:e=>{e.exports=JSON.parse('{"title":"Recent posts","items":[{"title":"Welcome","permalink":"/blog/welcome","unlisted":false,"date":"2021-08-26T00:00:00.000Z"},{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post","unlisted":false,"date":"2021-08-01T00:00:00.000Z"},{"title":"Long Blog Post","permalink":"/blog/long-blog-post","unlisted":false,"date":"2019-05-29T00:00:00.000Z"},{"title":"First Blog Post","permalink":"/blog/first-blog-post","unlisted":false,"date":"2019-05-28T00:00:00.000Z"}]}')}}]); \ No newline at end of file diff --git a/assets/js/8158.988a33bb.js b/assets/js/8158.988a33bb.js new file mode 100644 index 0000000000..8fc48c6462 --- /dev/null +++ b/assets/js/8158.988a33bb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8158],{8158:(c,s,a)=>{a.r(s),a.d(s,{DocSearchModal:()=>e.a1});var e=a(3219)}}]); \ No newline at end of file diff --git a/assets/js/822bd8ab.32be28a0.js b/assets/js/822bd8ab.32be28a0.js deleted file mode 100644 index aa5aca2958..0000000000 --- a/assets/js/822bd8ab.32be28a0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2748],{8611:(s,t,e)=>{e.r(t),e.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var n=e(4848),o=e(8453);const i={sidebar_position:6},r="Congratulations!",a={id:"tutorial-basics/congratulations",title:"Congratulations!",description:"You have just learned the basics of Docusaurus and made some changes to the initial template.",source:"@site/docs/tutorial-basics/congratulations.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/congratulations",permalink:"/docs/tutorial-basics/congratulations",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/congratulations.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6},sidebar:"tutorialSidebar",previous:{title:"Deploy your site",permalink:"/docs/tutorial-basics/deploy-your-site"},next:{title:"Best Practice",permalink:"/docs/advanced/best-practices"}},c={},u=[{value:"What's next?",id:"whats-next",level:2}];function d(s){const t={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...s.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"congratulations",children:"Congratulations!"}),"\n",(0,n.jsxs)(t.p,{children:["You have just learned the ",(0,n.jsx)(t.strong,{children:"basics of Docusaurus"})," and made some changes to the ",(0,n.jsx)(t.strong,{children:"initial template"}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["Docusaurus has ",(0,n.jsx)(t.strong,{children:"much more to offer"}),"!"]}),"\n",(0,n.jsxs)(t.p,{children:["Have ",(0,n.jsx)(t.strong,{children:"5 more minutes"}),"? Take a look at ",(0,n.jsx)(t.strong,{children:(0,n.jsx)(t.a,{href:"/docs/tutorial-extras/manage-docs-versions",children:"versioning"})})," and ",(0,n.jsx)(t.strong,{children:(0,n.jsx)(t.a,{href:"/docs/tutorial-extras/translate-your-site",children:"i18n"})}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["Anything ",(0,n.jsx)(t.strong,{children:"unclear"})," or ",(0,n.jsx)(t.strong,{children:"buggy"})," in this tutorial? ",(0,n.jsx)(t.a,{href:"https://github.com/facebook/docusaurus/discussions/4610",children:"Please report it!"})]}),"\n",(0,n.jsx)(t.h2,{id:"whats-next",children:"What's next?"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["Read the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/",children:"official documentation"})]}),"\n",(0,n.jsxs)(t.li,{children:["Modify your site configuration with ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/api/docusaurus-config",children:(0,n.jsx)(t.code,{children:"docusaurus.config.js"})})]}),"\n",(0,n.jsxs)(t.li,{children:["Add navbar and footer items with ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/api/themes/configuration",children:(0,n.jsx)(t.code,{children:"themeConfig"})})]}),"\n",(0,n.jsxs)(t.li,{children:["Add a custom ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/styling-layout",children:"Design and Layout"})]}),"\n",(0,n.jsxs)(t.li,{children:["Add a ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/search",children:"search bar"})]}),"\n",(0,n.jsxs)(t.li,{children:["Find inspirations in the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/showcase",children:"Docusaurus showcase"})]}),"\n",(0,n.jsxs)(t.li,{children:["Get involved in the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/community/support",children:"Docusaurus Community"})]}),"\n"]})]})}function l(s={}){const{wrapper:t}={...(0,o.R)(),...s.components};return t?(0,n.jsx)(t,{...s,children:(0,n.jsx)(d,{...s})}):d(s)}},8453:(s,t,e)=>{e.d(t,{R:()=>r,x:()=>a});var n=e(6540);const o={},i=n.createContext(o);function r(s){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof s?s(t):{...t,...s}}),[t,s])}function a(s){let t;return t=s.disableParentContext?"function"==typeof s.components?s.components(o):s.components||o:r(s.components),n.createElement(i.Provider,{value:t},s.children)}}}]); \ No newline at end of file diff --git a/assets/js/822bd8ab.85ed4075.js b/assets/js/822bd8ab.85ed4075.js new file mode 100644 index 0000000000..002b9a6827 --- /dev/null +++ b/assets/js/822bd8ab.85ed4075.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2748],{8611:(s,t,e)=>{e.r(t),e.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var n=e(4848),o=e(8453);const i={sidebar_position:6},r="Congratulations!",a={id:"tutorial-basics/congratulations",title:"Congratulations!",description:"You have just learned the basics of Docusaurus and made some changes to the initial template.",source:"@site/docs/tutorial-basics/congratulations.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/congratulations",permalink:"/docs/tutorial-basics/congratulations",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/congratulations.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6},sidebar:"tutorialSidebar",previous:{title:"Deploy your site",permalink:"/docs/tutorial-basics/deploy-your-site"},next:{title:"Best Practice",permalink:"/docs/advanced/best-practices"}},c={},u=[{value:"What's next?",id:"whats-next",level:2}];function d(s){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...s.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"congratulations",children:"Congratulations!"})}),"\n",(0,n.jsxs)(t.p,{children:["You have just learned the ",(0,n.jsx)(t.strong,{children:"basics of Docusaurus"})," and made some changes to the ",(0,n.jsx)(t.strong,{children:"initial template"}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["Docusaurus has ",(0,n.jsx)(t.strong,{children:"much more to offer"}),"!"]}),"\n",(0,n.jsxs)(t.p,{children:["Have ",(0,n.jsx)(t.strong,{children:"5 more minutes"}),"? Take a look at ",(0,n.jsx)(t.strong,{children:(0,n.jsx)(t.a,{href:"/docs/tutorial-extras/manage-docs-versions",children:"versioning"})})," and ",(0,n.jsx)(t.strong,{children:(0,n.jsx)(t.a,{href:"/docs/tutorial-extras/translate-your-site",children:"i18n"})}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["Anything ",(0,n.jsx)(t.strong,{children:"unclear"})," or ",(0,n.jsx)(t.strong,{children:"buggy"})," in this tutorial? ",(0,n.jsx)(t.a,{href:"https://github.com/facebook/docusaurus/discussions/4610",children:"Please report it!"})]}),"\n",(0,n.jsx)(t.h2,{id:"whats-next",children:"What's next?"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["Read the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/",children:"official documentation"})]}),"\n",(0,n.jsxs)(t.li,{children:["Modify your site configuration with ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/api/docusaurus-config",children:(0,n.jsx)(t.code,{children:"docusaurus.config.js"})})]}),"\n",(0,n.jsxs)(t.li,{children:["Add navbar and footer items with ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/api/themes/configuration",children:(0,n.jsx)(t.code,{children:"themeConfig"})})]}),"\n",(0,n.jsxs)(t.li,{children:["Add a custom ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/styling-layout",children:"Design and Layout"})]}),"\n",(0,n.jsxs)(t.li,{children:["Add a ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/docs/search",children:"search bar"})]}),"\n",(0,n.jsxs)(t.li,{children:["Find inspirations in the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/showcase",children:"Docusaurus showcase"})]}),"\n",(0,n.jsxs)(t.li,{children:["Get involved in the ",(0,n.jsx)(t.a,{href:"https://docusaurus.io/community/support",children:"Docusaurus Community"})]}),"\n"]})]})}function l(s={}){const{wrapper:t}={...(0,o.R)(),...s.components};return t?(0,n.jsx)(t,{...s,children:(0,n.jsx)(d,{...s})}):d(s)}},8453:(s,t,e)=>{e.d(t,{R:()=>r,x:()=>a});var n=e(6540);const o={},i=n.createContext(o);function r(s){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof s?s(t):{...t,...s}}),[t,s])}function a(s){let t;return t=s.disableParentContext?"function"==typeof s.components?s.components(o):s.components||o:r(s.components),n.createElement(i.Provider,{value:t},s.children)}}}]); \ No newline at end of file diff --git a/assets/js/82a3a055.c5f85df8.js b/assets/js/82a3a055.f88e227f.js similarity index 53% rename from assets/js/82a3a055.c5f85df8.js rename to assets/js/82a3a055.f88e227f.js index 90e0b0e784..021bf096e6 100644 --- a/assets/js/82a3a055.c5f85df8.js +++ b/assets/js/82a3a055.f88e227f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2040],{8154:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(4848),s=r(8453);const o={},c="Interface: DialogButtons",i={id:"reference/structures/Dialog/interfaces/DialogButtons",title:"Interface: DialogButtons",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogButtons.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogButtons.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps"},next:{title:"Interface: DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"value",id:"value",level:3}];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-dialogbuttons",children:"Interface: DialogButtons"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"label"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"value",children:"value"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"value"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>c,x:()=>i});var n=r(6540);const s={},o=n.createContext(s);function c(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2040],{8154:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(4848),s=r(8453);const o={},c="Interface: DialogButtons",i={id:"reference/structures/Dialog/interfaces/DialogButtons",title:"Interface: DialogButtons",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogButtons.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogButtons",permalink:"/docs/reference/structures/Dialog/interfaces/DialogButtons",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogButtons.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps"},next:{title:"Interface: DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"value",id:"value",level:3}];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"interface-dialogbuttons",children:"Interface: DialogButtons"})}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"label"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"value",children:"value"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"value"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>c,x:()=>i});var n=r(6540);const s={},o=n.createContext(s);function c(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83d3b456.58fd577f.js b/assets/js/83d3b456.58fd577f.js new file mode 100644 index 0000000000..560c671546 --- /dev/null +++ b/assets/js/83d3b456.58fd577f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8976],{678:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>a});var n=t(4848),c=t(8453);const d={},o="api/model/product",i={id:"reference/api/model/product/index",title:"api/model/product",description:"Index",source:"@site/docs/reference/api/model/product/index.md",sourceDirName:"reference/api/model/product",slug:"/reference/api/model/product/",permalink:"/docs/reference/api/model/product/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"},next:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"}},s={},a=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodelproduct",children:"api/model/product"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>i});var n=t(6540);const c={},d=n.createContext(c);function o(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83d3b456.a9c1c339.js b/assets/js/83d3b456.a9c1c339.js deleted file mode 100644 index f1daf5600a..0000000000 --- a/assets/js/83d3b456.a9c1c339.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8976],{678:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>a});var n=t(4848),c=t(8453);const d={},o="api/model/product",i={id:"reference/api/model/product/index",title:"api/model/product",description:"Index",source:"@site/docs/reference/api/model/product/index.md",sourceDirName:"reference/api/model/product",slug:"/reference/api/model/product/",permalink:"/docs/reference/api/model/product/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"},next:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"}},s={},a=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"apimodelproduct",children:"api/model/product"}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>i});var n=t(6540);const c={},d=n.createContext(c);function o(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/846f0159.66d39e43.js b/assets/js/846f0159.4cf5f151.js similarity index 52% rename from assets/js/846f0159.66d39e43.js rename to assets/js/846f0159.4cf5f151.js index 9206da8c27..2085143ac6 100644 --- a/assets/js/846f0159.66d39e43.js +++ b/assets/js/846f0159.4cf5f151.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6336],{5866:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>l});var a=s(4848),r=s(8453);const n={},o="Type Alias: ChatServer",i={id:"reference/api/model/aliases/type-aliases/ChatServer",title:"Type Alias: ChatServer",description:'ChatServer: "c.us"',source:"@site/docs/reference/api/model/aliases/type-aliases/ChatServer.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ChatServer.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId"},next:{title:"Type Alias: ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-chatserver",children:"Type Alias: ChatServer"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"ChatServer"}),": ",(0,a.jsx)(t.code,{children:'"c.us"'})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"The suffix used to identify a non-group chat id"})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>i});var a=s(6540);const r={},n=a.createContext(r);function o(e){const t=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6336],{5866:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>l});var a=s(4848),r=s(8453);const n={},o="Type Alias: ChatServer",i={id:"reference/api/model/aliases/type-aliases/ChatServer",title:"Type Alias: ChatServer",description:'ChatServer: "c.us"',source:"@site/docs/reference/api/model/aliases/type-aliases/ChatServer.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/ChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatServer",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/ChatServer.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId"},next:{title:"Type Alias: ContactId",permalink:"/docs/reference/api/model/aliases/type-aliases/ContactId"}},c={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"type-alias-chatserver",children:"Type Alias: ChatServer"})}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"ChatServer"}),": ",(0,a.jsx)(t.code,{children:'"c.us"'})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"The suffix used to identify a non-group chat id"})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>i});var a=s(6540);const r={},n=a.createContext(r);function o(e){const t=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8717b14a.ef8d7d23.js b/assets/js/8717b14a.ef8d7d23.js deleted file mode 100644 index 3fbf726746..0000000000 --- a/assets/js/8717b14a.ef8d7d23.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3694],{1615:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>g,frontMatter:()=>l,metadata:()=>r,toc:()=>c});var s=o(4848),n=o(8453);const l={slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},i=void 0,r={permalink:"/blog/long-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md",source:"@site/blog/2019-05-29-long-blog-post.md",title:"Long Blog Post",description:"This is the summary of a very long blog post,",date:"2019-05-29T00:00:00.000Z",tags:[{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:2.05,hasTruncateMarker:!0,authors:[{name:"Endilie Yacop Sucipto",title:"Maintainer of Docusaurus",url:"https://github.com/endiliey",imageURL:"https://github.com/endiliey.png",key:"endi"}],frontMatter:{slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},unlisted:!1,prevItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"},nextItem:{title:"First Blog Post",permalink:"/blog/first-blog-post"}},a={authorsImageUrls:[void 0]},c=[];function u(t){const e={code:"code",p:"p",...(0,n.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.p,{children:"This is the summary of a very long blog post,"}),"\n",(0,s.jsxs)(e.p,{children:["Use a ",(0,s.jsx)(e.code,{children:"\x3c!--"})," ",(0,s.jsx)(e.code,{children:"truncate"})," ",(0,s.jsx)(e.code,{children:"--\x3e"})," comment to limit blog post size in the list view."]})]})}function g(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(u,{...t})}):u(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>i,x:()=>r});var s=o(6540);const n={},l=s.createContext(n);function i(t){const e=s.useContext(l);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:i(t.components),s.createElement(l.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/8717b14a.f7bc5287.js b/assets/js/8717b14a.f7bc5287.js new file mode 100644 index 0000000000..012548f308 --- /dev/null +++ b/assets/js/8717b14a.f7bc5287.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3694],{1615:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>g,frontMatter:()=>l,metadata:()=>r,toc:()=>c});var s=o(4848),n=o(8453);const l={slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},i=void 0,r={permalink:"/blog/long-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md",source:"@site/blog/2019-05-29-long-blog-post.md",title:"Long Blog Post",description:"This is the summary of a very long blog post,",date:"2019-05-29T00:00:00.000Z",tags:[{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:2.05,hasTruncateMarker:!0,authors:[{name:"Endilie Yacop Sucipto",title:"Maintainer of Docusaurus",url:"https://github.com/endiliey",imageURL:"https://github.com/endiliey.png",key:"endi",page:null}],frontMatter:{slug:"long-blog-post",title:"Long Blog Post",authors:"endi",tags:["hello","docusaurus"]},unlisted:!1,prevItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"},nextItem:{title:"First Blog Post",permalink:"/blog/first-blog-post"}},a={authorsImageUrls:[void 0]},c=[];function u(t){const e={code:"code",p:"p",...(0,n.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.p,{children:"This is the summary of a very long blog post,"}),"\n",(0,s.jsxs)(e.p,{children:["Use a ",(0,s.jsx)(e.code,{children:"\x3c!--"})," ",(0,s.jsx)(e.code,{children:"truncate"})," ",(0,s.jsx)(e.code,{children:"--\x3e"})," comment to limit blog post size in the list view."]})]})}function g(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(u,{...t})}):u(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>i,x:()=>r});var s=o(6540);const n={},l=s.createContext(n);function i(t){const e=s.useContext(l);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:i(t.components),s.createElement(l.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/8997cb84.2b30ece9.js b/assets/js/8997cb84.2b30ece9.js new file mode 100644 index 0000000000..cd35de952d --- /dev/null +++ b/assets/js/8997cb84.2b30ece9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1397],{8697:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var s=r(4848),t=r(8453);const c={},i="Interface: LiveLocationChangedEvent",d={id:"reference/api/model/chat/interfaces/LiveLocationChangedEvent",title:"Interface: LiveLocationChangedEvent",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse"},next:{title:"Interface: SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"accuracy",id:"accuracy",level:3},{value:"degrees",id:"degrees",level:3},{value:"id",id:"id",level:3},{value:"lastUpdated",id:"lastupdated",level:3},{value:"lat",id:"lat",level:3},{value:"lng",id:"lng",level:3},{value:"msgId?",id:"msgid",level:3},{value:"speed",id:"speed",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-livelocationchangedevent",children:"Interface: LiveLocationChangedEvent"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"accuracy",children:"accuracy"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"accuracy"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"degrees",children:"degrees"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"degrees"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"lastupdated",children:"lastUpdated"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lastUpdated"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"lat",children:"lat"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lat"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"lng",children:"lng"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lng"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"msgid",children:"msgId?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"msgId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The message id that was sent when the liveLocation session was started."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"speed",children:"speed"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"speed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>d});var s=r(6540);const t={},c=s.createContext(t);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8997cb84.88160c68.js b/assets/js/8997cb84.88160c68.js deleted file mode 100644 index 7eddaab33a..0000000000 --- a/assets/js/8997cb84.88160c68.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1397],{8697:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var r=s(4848),t=s(8453);const c={},i="Interface: LiveLocationChangedEvent",d={id:"reference/api/model/chat/interfaces/LiveLocationChangedEvent",title:"Interface: LiveLocationChangedEvent",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse"},next:{title:"Interface: SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"accuracy",id:"accuracy",level:3},{value:"degrees",id:"degrees",level:3},{value:"id",id:"id",level:3},{value:"lastUpdated",id:"lastupdated",level:3},{value:"lat",id:"lat",level:3},{value:"lng",id:"lng",level:3},{value:"msgId?",id:"msgid",level:3},{value:"speed",id:"speed",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-livelocationchangedevent",children:"Interface: LiveLocationChangedEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"accuracy",children:"accuracy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"accuracy"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"degrees",children:"degrees"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"degrees"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lastupdated",children:"lastUpdated"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"lastUpdated"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lat",children:"lat"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"lat"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lng",children:"lng"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"lng"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgid",children:"msgId?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"msgId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message id that was sent when the liveLocation session was started."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"speed",children:"speed"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"speed"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>d});var r=s(6540);const t={},c=r.createContext(t);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a0e406a.3e5885ab.js b/assets/js/8a0e406a.3e5885ab.js new file mode 100644 index 0000000000..2ed1a46e99 --- /dev/null +++ b/assets/js/8a0e406a.3e5885ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4696],{9516:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=a(4848),n=a(8453);const o={},s="Type Alias: EphemeralDuration",c={id:"reference/api/model/chat/type-aliases/EphemeralDuration",title:"Type Alias: EphemeralDuration",description:"EphemeralDuration: 86400 \\| 604800 \\| 7776000",source:"@site/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",sourceDirName:"reference/api/model/chat/type-aliases",slug:"/reference/api/model/chat/type-aliases/EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat"},next:{title:"api/model/config",permalink:"/docs/reference/api/model/config/"}},i={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"type-alias-ephemeralduration",children:"Type Alias: EphemeralDuration"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"EphemeralDuration"}),": ",(0,r.jsx)(t.code,{children:"86400"})," | ",(0,r.jsx)(t.code,{children:"604800"})," | ",(0,r.jsx)(t.code,{children:"7776000"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"Ephemeral duration can be 1 day, 7 days or 90 days. The default is 1 day."})]})}function p(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>s,x:()=>c});var r=a(6540);const n={},o=r.createContext(n);function s(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a0e406a.504d255a.js b/assets/js/8a0e406a.504d255a.js deleted file mode 100644 index e0bf63c763..0000000000 --- a/assets/js/8a0e406a.504d255a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4696],{9516:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=a(4848),n=a(8453);const o={},s="Type Alias: EphemeralDuration",c={id:"reference/api/model/chat/type-aliases/EphemeralDuration",title:"Type Alias: EphemeralDuration",description:"EphemeralDuration: 86400 \\| 604800 \\| 7776000",source:"@site/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",sourceDirName:"reference/api/model/chat/type-aliases",slug:"/reference/api/model/chat/type-aliases/EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat"},next:{title:"api/model/config",permalink:"/docs/reference/api/model/config/"}},i={},l=[];function d(e){const t={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"type-alias-ephemeralduration",children:"Type Alias: EphemeralDuration"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"EphemeralDuration"}),": ",(0,r.jsx)(t.code,{children:"86400"})," | ",(0,r.jsx)(t.code,{children:"604800"})," | ",(0,r.jsx)(t.code,{children:"7776000"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"Ephemeral duration can be 1 day, 7 days or 90 days. The default is 1 day."})]})}function p(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>s,x:()=>c});var r=a(6540);const n={},o=r.createContext(n);function s(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a376d68.2b5faabb.js b/assets/js/8a376d68.2b5faabb.js new file mode 100644 index 0000000000..2e9032c4cc --- /dev/null +++ b/assets/js/8a376d68.2b5faabb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1808],{8086:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>o,toc:()=>i});var r=s(4848),l=s(8453);const d={},t="Enumeration: SimpleListener",o={id:"reference/api/model/events/enumerations/SimpleListener",title:"Enumeration: SimpleListener",description:'An enum of all the "simple listeners". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.',source:"@site/docs/reference/api/model/events/enumerations/SimpleListener.md",sourceDirName:"reference/api/model/events/enumerations",slug:"/reference/api/model/events/enumerations/SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/events/enumerations/SimpleListener.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/events",permalink:"/docs/reference/api/model/events/"},next:{title:"api/model/group-metadata",permalink:"/docs/reference/api/model/group-metadata/"}},c={},i=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Ack",id:"ack",level:3},{value:"AddedToGroup",id:"addedtogroup",level:3},{value:"AnyMessage",id:"anymessage",level:3},{value:"Battery",id:"battery",level:3},{value:"Broadcast",id:"broadcast",level:3},{value:"Button",id:"button",level:3},{value:"CallState",id:"callstate",level:3},{value:"ChatDeleted",id:"chatdeleted",level:3},{value:"ChatOpened",id:"chatopened",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ContactAdded",id:"contactadded",level:3},{value:"GlobalParticipantsChanged",id:"globalparticipantschanged",level:3},{value:"GroupApprovalRequest",id:"groupapprovalrequest",level:3},{value:"GroupChange",id:"groupchange",level:3},{value:"IncomingCall",id:"incomingcall",level:3},{value:"Label",id:"label",level:3},{value:"Logout",id:"logout",level:3},{value:"Message",id:"message",level:3},{value:"MessageDeleted",id:"messagedeleted",level:3},{value:"NewProduct",id:"newproduct",level:3},{value:"Order",id:"order",level:3},{value:"Plugged",id:"plugged",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Reaction",id:"reaction",level:3},{value:"RemovedFromGroup",id:"removedfromgroup",level:3},{value:"StateChanged",id:"statechanged",level:3},{value:"Story",id:"story",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-simplelistener",children:"Enumeration: SimpleListener"})}),"\n",(0,r.jsx)(n.p,{children:'An enum of all the "simple listeners". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.'}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"Ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Ack"}),": ",(0,r.jsx)(n.code,{children:'"onAck"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAck]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"addedtogroup",children:"AddedToGroup"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AddedToGroup"}),": ",(0,r.jsx)(n.code,{children:'"onAddedToGroup"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAddedToGroup]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"anymessage",children:"AnyMessage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AnyMessage"}),": ",(0,r.jsx)(n.code,{children:'"onAnyMessage"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAnyMessage]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"battery",children:"Battery"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Battery"}),": ",(0,r.jsx)(n.code,{children:'"onBattery"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onBattery]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"broadcast",children:"Broadcast"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Broadcast"}),": ",(0,r.jsx)(n.code,{children:'"onBroadcast"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onBroadcast]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"button",children:"Button"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Button"}),": ",(0,r.jsx)(n.code,{children:'"onButton"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onButton]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"callstate",children:"CallState"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CallState"}),": ",(0,r.jsx)(n.code,{children:'"onCallState"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onIncomingCall]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatdeleted",children:"ChatDeleted"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatDeleted"}),": ",(0,r.jsx)(n.code,{children:'"onChatDeleted"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatDeleted]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatopened",children:"ChatOpened"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatOpened"}),": ",(0,r.jsx)(n.code,{children:'"onChatOpened"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatOpened]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatState"}),": ",(0,r.jsx)(n.code,{children:'"onChatState"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatState]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contactadded",children:"ContactAdded"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ContactAdded"}),": ",(0,r.jsx)(n.code,{children:'"onContactAdded"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onContactAdded]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"globalparticipantschanged",children:"GlobalParticipantsChanged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GlobalParticipantsChanged"}),": ",(0,r.jsx)(n.code,{children:'"onGlobalParticipantsChanged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onGlobalParticipantsChanged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupapprovalrequest",children:"GroupApprovalRequest"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupApprovalRequest"}),": ",(0,r.jsx)(n.code,{children:'"onGroupApprovalRequest"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onGroupApprovalRequest]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupchange",children:"GroupChange"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupChange"}),": ",(0,r.jsx)(n.code,{children:'"onGroupChange"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onGroupChange]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"incomingcall",children:"IncomingCall"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IncomingCall"}),": ",(0,r.jsx)(n.code,{children:'"onIncomingCall"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onIncomingCall]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"label",children:"Label"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Label"}),": ",(0,r.jsx)(n.code,{children:'"onLabel"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onLabel]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"logout",children:"Logout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Logout"}),": ",(0,r.jsx)(n.code,{children:'"onLogout"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onLogout]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"Message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Message"}),": ",(0,r.jsx)(n.code,{children:'"onMessage"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onMessage]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"messagedeleted",children:"MessageDeleted"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MessageDeleted"}),": ",(0,r.jsx)(n.code,{children:'"onMessageDeleted"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onMessageDeleted]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"newproduct",children:"NewProduct"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NewProduct"}),": ",(0,r.jsx)(n.code,{children:'"onNewProduct"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onNewProduct]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"order",children:"Order"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Order"}),": ",(0,r.jsx)(n.code,{children:'"onOrder"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onContactAdded]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"plugged",children:"Plugged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Plugged"}),": ",(0,r.jsx)(n.code,{children:'"onPlugged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onPlugged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PollVote"}),": ",(0,r.jsx)(n.code,{children:'"onPollVote"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onButton]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reaction",children:"Reaction"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Reaction"}),": ",(0,r.jsx)(n.code,{children:'"onReaction"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onReaction]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removedfromgroup",children:"RemovedFromGroup"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"RemovedFromGroup"}),": ",(0,r.jsx)(n.code,{children:'"onRemovedFromGroup"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onRemovedFromGroup]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"statechanged",children:"StateChanged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"StateChanged"}),": ",(0,r.jsx)(n.code,{children:'"onStateChanged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onStateChanged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"story",children:"Story"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Story"}),": ",(0,r.jsx)(n.code,{children:'"onStory"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onStory]]"})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>o});var r=s(6540);const l={},d=r.createContext(l);function t(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a376d68.a05a8773.js b/assets/js/8a376d68.a05a8773.js deleted file mode 100644 index d115790f51..0000000000 --- a/assets/js/8a376d68.a05a8773.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1808],{8086:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>a,frontMatter:()=>d,metadata:()=>o,toc:()=>i});var r=s(4848),l=s(8453);const d={},t="Enumeration: SimpleListener",o={id:"reference/api/model/events/enumerations/SimpleListener",title:"Enumeration: SimpleListener",description:'An enum of all the "simple listeners". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.',source:"@site/docs/reference/api/model/events/enumerations/SimpleListener.md",sourceDirName:"reference/api/model/events/enumerations",slug:"/reference/api/model/events/enumerations/SimpleListener",permalink:"/docs/reference/api/model/events/enumerations/SimpleListener",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/events/enumerations/SimpleListener.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/events",permalink:"/docs/reference/api/model/events/"},next:{title:"api/model/group-metadata",permalink:"/docs/reference/api/model/group-metadata/"}},c={},i=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Ack",id:"ack",level:3},{value:"AddedToGroup",id:"addedtogroup",level:3},{value:"AnyMessage",id:"anymessage",level:3},{value:"Battery",id:"battery",level:3},{value:"Broadcast",id:"broadcast",level:3},{value:"Button",id:"button",level:3},{value:"CallState",id:"callstate",level:3},{value:"ChatDeleted",id:"chatdeleted",level:3},{value:"ChatOpened",id:"chatopened",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ContactAdded",id:"contactadded",level:3},{value:"GlobalParticipantsChanged",id:"globalparticipantschanged",level:3},{value:"GroupApprovalRequest",id:"groupapprovalrequest",level:3},{value:"GroupChange",id:"groupchange",level:3},{value:"IncomingCall",id:"incomingcall",level:3},{value:"Label",id:"label",level:3},{value:"Logout",id:"logout",level:3},{value:"Message",id:"message",level:3},{value:"MessageDeleted",id:"messagedeleted",level:3},{value:"NewProduct",id:"newproduct",level:3},{value:"Order",id:"order",level:3},{value:"Plugged",id:"plugged",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Reaction",id:"reaction",level:3},{value:"RemovedFromGroup",id:"removedfromgroup",level:3},{value:"StateChanged",id:"statechanged",level:3},{value:"Story",id:"story",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-simplelistener",children:"Enumeration: SimpleListener"}),"\n",(0,r.jsx)(n.p,{children:'An enum of all the "simple listeners". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.'}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"Ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Ack"}),": ",(0,r.jsx)(n.code,{children:'"onAck"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAck]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"addedtogroup",children:"AddedToGroup"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AddedToGroup"}),": ",(0,r.jsx)(n.code,{children:'"onAddedToGroup"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAddedToGroup]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"anymessage",children:"AnyMessage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AnyMessage"}),": ",(0,r.jsx)(n.code,{children:'"onAnyMessage"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onAnyMessage]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"battery",children:"Battery"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Battery"}),": ",(0,r.jsx)(n.code,{children:'"onBattery"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onBattery]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"broadcast",children:"Broadcast"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Broadcast"}),": ",(0,r.jsx)(n.code,{children:'"onBroadcast"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onBroadcast]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"button",children:"Button"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Button"}),": ",(0,r.jsx)(n.code,{children:'"onButton"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onButton]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"callstate",children:"CallState"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CallState"}),": ",(0,r.jsx)(n.code,{children:'"onCallState"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onIncomingCall]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatdeleted",children:"ChatDeleted"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatDeleted"}),": ",(0,r.jsx)(n.code,{children:'"onChatDeleted"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatDeleted]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatopened",children:"ChatOpened"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatOpened"}),": ",(0,r.jsx)(n.code,{children:'"onChatOpened"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatOpened]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ChatState"}),": ",(0,r.jsx)(n.code,{children:'"onChatState"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onChatState]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"contactadded",children:"ContactAdded"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ContactAdded"}),": ",(0,r.jsx)(n.code,{children:'"onContactAdded"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onContactAdded]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"globalparticipantschanged",children:"GlobalParticipantsChanged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GlobalParticipantsChanged"}),": ",(0,r.jsx)(n.code,{children:'"onGlobalParticipantsChanged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onGlobalParticipantsChanged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupapprovalrequest",children:"GroupApprovalRequest"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupApprovalRequest"}),": ",(0,r.jsx)(n.code,{children:'"onGroupApprovalRequest"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onGroupApprovalRequest]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"groupchange",children:"GroupChange"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GroupChange"}),": ",(0,r.jsx)(n.code,{children:'"onGroupChange"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onGroupChange]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"incomingcall",children:"IncomingCall"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IncomingCall"}),": ",(0,r.jsx)(n.code,{children:'"onIncomingCall"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onIncomingCall]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"label",children:"Label"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Label"}),": ",(0,r.jsx)(n.code,{children:'"onLabel"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onLabel]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"logout",children:"Logout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Logout"}),": ",(0,r.jsx)(n.code,{children:'"onLogout"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onLogout]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"Message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Message"}),": ",(0,r.jsx)(n.code,{children:'"onMessage"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onMessage]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"messagedeleted",children:"MessageDeleted"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MessageDeleted"}),": ",(0,r.jsx)(n.code,{children:'"onMessageDeleted"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onMessageDeleted]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"newproduct",children:"NewProduct"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NewProduct"}),": ",(0,r.jsx)(n.code,{children:'"onNewProduct"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onNewProduct]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"order",children:"Order"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Order"}),": ",(0,r.jsx)(n.code,{children:'"onOrder"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onContactAdded]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"plugged",children:"Plugged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Plugged"}),": ",(0,r.jsx)(n.code,{children:'"onPlugged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onPlugged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PollVote"}),": ",(0,r.jsx)(n.code,{children:'"onPollVote"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onButton]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reaction",children:"Reaction"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Reaction"}),": ",(0,r.jsx)(n.code,{children:'"onReaction"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onReaction]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removedfromgroup",children:"RemovedFromGroup"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"RemovedFromGroup"}),": ",(0,r.jsx)(n.code,{children:'"onRemovedFromGroup"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onRemovedFromGroup]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"statechanged",children:"StateChanged"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"StateChanged"}),": ",(0,r.jsx)(n.code,{children:'"onStateChanged"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Represents [[onStateChanged]]"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"story",children:"Story"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Story"}),": ",(0,r.jsx)(n.code,{children:'"onStory"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Requires licence\nRepresents [[onStory]]"})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>o});var r=s(6540);const l={},d=r.createContext(l);function t(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ebd32b9.a6fa9ede.js b/assets/js/8ebd32b9.a6fa9ede.js deleted file mode 100644 index 517f7c9471..0000000000 --- a/assets/js/8ebd32b9.a6fa9ede.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1800],{2594:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>a,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var s=r(4848),l=r(8453);const c={},i="Class: MessageCollector",t={id:"reference/structures/MessageCollector/classes/MessageCollector",title:"Class: MessageCollector",description:"Collects messages on a chat.",source:"@site/docs/reference/structures/MessageCollector/classes/MessageCollector.md",sourceDirName:"reference/structures/MessageCollector/classes",slug:"/reference/structures/MessageCollector/classes/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/MessageCollector/classes/MessageCollector.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/"},next:{title:"structures/preProcessors",permalink:"/docs/reference/structures/preProcessors/"}},d={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new MessageCollector()",id:"new-messagecollector",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Emits",id:"emits",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_idletimeout",id:"_idletimeout",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"_timeout",id:"_timeout",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"chat",id:"chat",level:3},{value:"collected",id:"collected",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"ended",id:"ended",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"ev",id:"ev",level:3},{value:"filter()",id:"filter",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"instanceId",id:"instanceid",level:3},{value:"options",id:"options",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"received",id:"received",level:3},{value:"sessionId",id:"sessionid",level:3},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Accessors",id:"accessors",level:2},{value:"next",id:"next",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Methods",id:"methods",level:2},{value:"[asyncIterator]()",id:"asynciterator",level:3},{value:"Returns",id:"returns-3",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"checkEnd()",id:"checkend",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"clearImmediate()",id:"clearimmediate",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"clearInterval()",id:"clearinterval",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"clearTimeout()",id:"cleartimeout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"emit()",id:"emit",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"eventSignature()",id:"eventsignature",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-13",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"handleCollect()",id:"handlecollect",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Emits",id:"emits-1",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"handleDispose()",id:"handledispose",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Emits",id:"emits-2",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"on()",id:"on",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"once()",id:"once",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Since",id:"since-11",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Since",id:"since-12",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"resetTimer()",id:"resettimer",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"setImmediate()",id:"setimmediate",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"setInterval()",id:"setinterval",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Since",id:"since-14",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"setTimeout()",id:"settimeout",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Emits",id:"emits-3",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"wrapHandler()",id:"wraphandler",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Parameters",id:"parameters-28",level:5},{value:"Returns",id:"returns-34",level:5},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Since",id:"since-15",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Since",id:"since-16",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-18",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Since",id:"since-19",level:4},{value:"Inherited from",id:"inherited-from-44",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"class-messagecollector",children:"Class: MessageCollector"}),"\n",(0,s.jsxs)(n.p,{children:["Collects messages on a chat.\nWill automatically stop if the chat (",(0,s.jsx)(n.code,{children:"'chatDelete'"}),") is deleted."]}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-messagecollector",children:"new MessageCollector()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new MessageCollector"}),"(",(0,s.jsx)(n.code,{children:"sessionId"}),", ",(0,s.jsx)(n.code,{children:"instanceId"}),", ",(0,s.jsx)(n.code,{children:"chat"}),", ",(0,s.jsx)(n.code,{children:"filter"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"openWaEventEmitter"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the session"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"instanceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the current instance of the session (see: client.getInstanceId)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"chat"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,s.jsx)(n.code,{children:"ChatId"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"})]}),"\n",(0,s.jsx)(n.p,{children:"The filter to be applied to this collector"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})," = ",(0,s.jsx)(n.code,{children:"{}"})]}),"\n",(0,s.jsx)(n.p,{children:"The options to be applied to this collector"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"openWaEventEmitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter2"})]}),"\n",(0,s.jsxs)(n.p,{children:["The EventEmitter2 that fires all open-wa events. In local instances of the library, this is the global ",(0,s.jsx)(n.code,{children:"ev"})," object."]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})}),"\n",(0,s.jsx)(n.h4,{id:"emits",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"MessageCollector#Message"}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#constructors",children:(0,s.jsx)(n.code,{children:"constructor"})})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"_idletimeout",children:"_idletimeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_idletimeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#_idletimeout",children:(0,s.jsx)(n.code,{children:"_idletimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_timeout",children:"_timeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#_timeout",children:(0,s.jsx)(n.code,{children:"_timeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"chat",children:"chat"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"chat"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,s.jsx)(n.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collected",children:"collected"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collected"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#collected",children:(0,s.jsx)(n.code,{children:"collected"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ended",children:"ended"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#ended",children:(0,s.jsx)(n.code,{children:"ended"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ev",children:"ev"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ev"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter2"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),": (...",(0,s.jsx)(n.code,{children:"args"}),") => ",(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#filter",children:(0,s.jsx)(n.code,{children:"filter"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"instanceid",children:"instanceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"instanceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#options",children:(0,s.jsx)(n.code,{children:"options"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"received",children:"received"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"received"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sessionid",children:"sessionId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejections",children:(0,s.jsx)(n.code,{children:"captureRejections"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#defaultmaxlisteners",children:(0,s.jsx)(n.code,{children:"defaultMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,s.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,s.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,s.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,s.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,s.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n",(0,s.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,s.jsx)(n.h3,{id:"next",children:"next"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"get"})," ",(0,s.jsx)(n.strong,{children:"next"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a promise that resolves with the next collected element;\nrejects with collected elements if the collector finishes without receiving a next element"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#next",children:(0,s.jsx)(n.code,{children:"next"})})]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"asynciterator",children:"[asyncIterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[asyncIterator]"}),"(): ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Allows collectors to be consumed with for-await-of loops"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of",children:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#%5Basynciterator%5D",children:(0,s.jsx)(n.code,{children:"[asyncIterator]"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"addListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#addlistener",children:(0,s.jsx)(n.code,{children:"addListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"checkend",children:"checkEnd()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"checkEnd"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks whether the collector should end, and if so, ends it."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#checkend",children:(0,s.jsx)(n.code,{children:"checkEnd"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearimmediate",children:"clearImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearImmediate"}),"(",(0,s.jsx)(n.code,{children:"immediate"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an immediate."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"immediate"}),": ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n",(0,s.jsx)(n.p,{children:"Immediate to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#clearimmediate",children:(0,s.jsx)(n.code,{children:"clearImmediate"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearinterval",children:"clearInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearInterval"}),"(",(0,s.jsx)(n.code,{children:"interval"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an interval."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"interval"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Interval to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#clearinterval",children:(0,s.jsx)(n.code,{children:"clearInterval"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cleartimeout",children:"clearTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearTimeout"}),"(",(0,s.jsx)(n.code,{children:"timeout"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears a timeout."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#cleartimeout",children:(0,s.jsx)(n.code,{children:"clearTimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destroy"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Destroys all assets used by the base client."}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#destroy",children:(0,s.jsx)(n.code,{children:"destroy"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(",(0,s.jsx)(n.code,{children:"message"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,s.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Handles a message for possible disposal."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(n.code,{children:"Message"})})]}),"\n",(0,s.jsx)(n.p,{children:"The message that could be disposed of"}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,s.jsx)(n.code,{children:"MessageId"})})}),"\n",(0,s.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"emit"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,s.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns ",(0,s.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#emit",children:(0,s.jsx)(n.code,{children:"emit"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,s.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["(",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#eventnames",children:(0,s.jsx)(n.code,{children:"eventNames"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventsignature",children:"eventSignature()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventSignature"}),"(",(0,s.jsx)(n.code,{children:"event"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,s.jsx)(n.code,{children:"SimpleListener"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#getmaxlisteners",children:(0,s.jsx)(n.code,{children:"getMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlecollect",children:"handleCollect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleCollect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to handle an event as a collectable element. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-1",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#collect"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#handlecollect",children:(0,s.jsx)(n.code,{children:"handleCollect"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handledispose",children:"handleDispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleDispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to remove an element from the collection. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-2",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#dispose"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#handledispose",children:(0,s.jsx)(n.code,{children:"handleDispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listenercount",children:(0,s.jsx)(n.code,{children:"listenerCount"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listeners",children:(0,s.jsx)(n.code,{children:"listeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"off"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#off",children:(0,s.jsx)(n.code,{children:"off"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#on",children:(0,s.jsx)(n.code,{children:"on"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#prependlistener",children:(0,s.jsx)(n.code,{children:"prependListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"})," to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#prependoncelistener",children:(0,s.jsx)(n.code,{children:"prependOnceListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rawListeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,s.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-11",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#rawlisteners",children:(0,s.jsx)(n.code,{children:"rawListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,s.jsx)(n.code,{children:"event"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event?"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-12",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#removealllisteners",children:(0,s.jsx)(n.code,{children:"removeAllListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes the specified ",(0,s.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,s.jsx)(n.code,{children:"eventName"}),", then ",(0,s.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,s.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,s.jsx)(n.code,{children:"removeListener()"})," or ",(0,s.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,s.jsx)(n.em,{children:"after"})," emitting and ",(0,s.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,s.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,s.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,s.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,s.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,s.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,s.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-13",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#removelistener",children:(0,s.jsx)(n.code,{children:"removeListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resettimer",children:"resetTimer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"resetTimer"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Resets the collectors timeout and idle timer."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"})," = ",(0,s.jsx)(n.code,{children:"..."})]}),"\n",(0,s.jsx)(n.p,{children:"Options"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.idle?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to stop the collector after inactivity in milliseconds"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.time?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to run the collector for in milliseconds"}),"\n",(0,s.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#resettimer",children:(0,s.jsx)(n.code,{children:"resetTimer"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setimmediate",children:"setImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setImmediate"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an immediate that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Immediate"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setimmediate",children:(0,s.jsx)(n.code,{children:"setImmediate"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setinterval",children:"setInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setInterval"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an interval that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait between executions (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setinterval",children:(0,s.jsx)(n.code,{children:"setInterval"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["By default ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,s.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,s.jsx)(n.code,{children:"Infinity"})," (or ",(0,s.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-14",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setmaxlisteners",children:(0,s.jsx)(n.code,{children:"setMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settimeout",children:"setTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setTimeout"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets a timeout that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait before executing (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#settimeout",children:(0,s.jsx)(n.code,{children:"setTimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"reason"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Stops this collector and emits the ",(0,s.jsx)(n.code,{children:"end"})," event."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"reason?"}),": ",(0,s.jsx)(n.code,{children:"string"})," = ",(0,s.jsx)(n.code,{children:"'user'"})]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector is ending"}),"\n",(0,s.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"emits-3",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#end"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#stop",children:(0,s.jsx)(n.code,{children:"stop"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"wraphandler",children:"wrapHandler()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"wrapHandler"}),"(",(0,s.jsx)(n.code,{children:"handler"}),"): (",(0,s.jsx)(n.code,{children:"__namedParameters"}),") => ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"handler"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Function"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"__namedParameters"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"__namedParameters.data"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"name"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,s.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-15",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#geteventlisteners",children:(0,s.jsx)(n.code,{children:"getEventListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount-1",children:(0,s.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,s.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,s.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-16",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,s.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,s.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,s.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listenercount-1",children:(0,s.jsx)(n.code,{children:"listenerCount"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns an ",(0,s.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,s.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,s.jsx)(n.code,{children:"emitter"})]}),"\n",(0,s.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#on-1",children:(0,s.jsx)(n.code,{children:"on"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Creates a ",(0,s.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,s.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,s.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,s.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,s.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,s.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The special handling of the ",(0,s.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,s.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,s.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,s.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"since-18",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once-1",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once-1",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"?, ...",(0,s.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n?"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,s.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-40",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"since-19",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setmaxlisteners-1",children:(0,s.jsx)(n.code,{children:"setMaxListeners"})})]})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>t});var s=r(6540);const l={},c=s.createContext(l);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ebd32b9.dede4af1.js b/assets/js/8ebd32b9.dede4af1.js new file mode 100644 index 0000000000..7532afbe23 --- /dev/null +++ b/assets/js/8ebd32b9.dede4af1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1800],{2594:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>a,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var s=r(4848),l=r(8453);const c={},i="Class: MessageCollector",t={id:"reference/structures/MessageCollector/classes/MessageCollector",title:"Class: MessageCollector",description:"Collects messages on a chat.",source:"@site/docs/reference/structures/MessageCollector/classes/MessageCollector.md",sourceDirName:"reference/structures/MessageCollector/classes",slug:"/reference/structures/MessageCollector/classes/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/MessageCollector/classes/MessageCollector.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/MessageCollector",permalink:"/docs/reference/structures/MessageCollector/"},next:{title:"structures/preProcessors",permalink:"/docs/reference/structures/preProcessors/"}},d={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new MessageCollector()",id:"new-messagecollector",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Emits",id:"emits",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_idletimeout",id:"_idletimeout",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"_timeout",id:"_timeout",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"chat",id:"chat",level:3},{value:"collected",id:"collected",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"ended",id:"ended",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"ev",id:"ev",level:3},{value:"filter()",id:"filter",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"instanceId",id:"instanceid",level:3},{value:"options",id:"options",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"received",id:"received",level:3},{value:"sessionId",id:"sessionid",level:3},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Accessors",id:"accessors",level:2},{value:"next",id:"next",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Methods",id:"methods",level:2},{value:"[asyncIterator]()",id:"asynciterator",level:3},{value:"Returns",id:"returns-3",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"checkEnd()",id:"checkend",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"clearImmediate()",id:"clearimmediate",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"clearInterval()",id:"clearinterval",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"clearTimeout()",id:"cleartimeout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"emit()",id:"emit",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"eventSignature()",id:"eventsignature",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-13",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"handleCollect()",id:"handlecollect",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Emits",id:"emits-1",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"handleDispose()",id:"handledispose",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Emits",id:"emits-2",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"on()",id:"on",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"once()",id:"once",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Since",id:"since-11",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Since",id:"since-12",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"resetTimer()",id:"resettimer",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"setImmediate()",id:"setimmediate",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"setInterval()",id:"setinterval",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Since",id:"since-14",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"setTimeout()",id:"settimeout",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Emits",id:"emits-3",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"wrapHandler()",id:"wraphandler",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Parameters",id:"parameters-28",level:5},{value:"Returns",id:"returns-34",level:5},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Since",id:"since-15",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Since",id:"since-16",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-18",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Since",id:"since-19",level:4},{value:"Inherited from",id:"inherited-from-44",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"class-messagecollector",children:"Class: MessageCollector"})}),"\n",(0,s.jsxs)(n.p,{children:["Collects messages on a chat.\nWill automatically stop if the chat (",(0,s.jsx)(n.code,{children:"'chatDelete'"}),") is deleted."]}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-messagecollector",children:"new MessageCollector()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new MessageCollector"}),"(",(0,s.jsx)(n.code,{children:"sessionId"}),", ",(0,s.jsx)(n.code,{children:"instanceId"}),", ",(0,s.jsx)(n.code,{children:"chat"}),", ",(0,s.jsx)(n.code,{children:"filter"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"openWaEventEmitter"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the session"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"instanceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the current instance of the session (see: client.getInstanceId)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"chat"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,s.jsx)(n.code,{children:"ChatId"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"})]}),"\n",(0,s.jsx)(n.p,{children:"The filter to be applied to this collector"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})," = ",(0,s.jsx)(n.code,{children:"{}"})]}),"\n",(0,s.jsx)(n.p,{children:"The options to be applied to this collector"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"openWaEventEmitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter2"})]}),"\n",(0,s.jsxs)(n.p,{children:["The EventEmitter2 that fires all open-wa events. In local instances of the library, this is the global ",(0,s.jsx)(n.code,{children:"ev"})," object."]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})}),"\n",(0,s.jsx)(n.h4,{id:"emits",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"MessageCollector#Message"}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#constructors",children:(0,s.jsx)(n.code,{children:"constructor"})})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"_idletimeout",children:"_idletimeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_idletimeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#_idletimeout",children:(0,s.jsx)(n.code,{children:"_idletimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_timeout",children:"_timeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#_timeout",children:(0,s.jsx)(n.code,{children:"_timeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"chat",children:"chat"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"chat"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,s.jsx)(n.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collected",children:"collected"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collected"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#collected",children:(0,s.jsx)(n.code,{children:"collected"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ended",children:"ended"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#ended",children:(0,s.jsx)(n.code,{children:"ended"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ev",children:"ev"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ev"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter2"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),": (...",(0,s.jsx)(n.code,{children:"args"}),") => ",(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#filter",children:(0,s.jsx)(n.code,{children:"filter"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"instanceid",children:"instanceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"instanceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#options",children:(0,s.jsx)(n.code,{children:"options"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"received",children:"received"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"received"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sessionid",children:"sessionId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejections",children:(0,s.jsx)(n.code,{children:"captureRejections"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#defaultmaxlisteners",children:(0,s.jsx)(n.code,{children:"defaultMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,s.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,s.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,s.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,s.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,s.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n",(0,s.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,s.jsx)(n.h3,{id:"next",children:"next"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"get"})," ",(0,s.jsx)(n.strong,{children:"next"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a promise that resolves with the next collected element;\nrejects with collected elements if the collector finishes without receiving a next element"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#next",children:(0,s.jsx)(n.code,{children:"next"})})]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"asynciterator",children:"[asyncIterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[asyncIterator]"}),"(): ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Allows collectors to be consumed with for-await-of loops"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of",children:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#%5Basynciterator%5D",children:(0,s.jsx)(n.code,{children:"[asyncIterator]"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"addListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#addlistener",children:(0,s.jsx)(n.code,{children:"addListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"checkend",children:"checkEnd()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"checkEnd"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks whether the collector should end, and if so, ends it."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#checkend",children:(0,s.jsx)(n.code,{children:"checkEnd"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearimmediate",children:"clearImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearImmediate"}),"(",(0,s.jsx)(n.code,{children:"immediate"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an immediate."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"immediate"}),": ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n",(0,s.jsx)(n.p,{children:"Immediate to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#clearimmediate",children:(0,s.jsx)(n.code,{children:"clearImmediate"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearinterval",children:"clearInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearInterval"}),"(",(0,s.jsx)(n.code,{children:"interval"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an interval."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"interval"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Interval to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#clearinterval",children:(0,s.jsx)(n.code,{children:"clearInterval"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cleartimeout",children:"clearTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearTimeout"}),"(",(0,s.jsx)(n.code,{children:"timeout"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears a timeout."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#cleartimeout",children:(0,s.jsx)(n.code,{children:"clearTimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destroy"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Destroys all assets used by the base client."}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#destroy",children:(0,s.jsx)(n.code,{children:"destroy"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(",(0,s.jsx)(n.code,{children:"message"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,s.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Handles a message for possible disposal."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,s.jsx)(n.code,{children:"Message"})})]}),"\n",(0,s.jsx)(n.p,{children:"The message that could be disposed of"}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,s.jsx)(n.code,{children:"MessageId"})})}),"\n",(0,s.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"emit"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,s.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns ",(0,s.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#emit",children:(0,s.jsx)(n.code,{children:"emit"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,s.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["(",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#eventnames",children:(0,s.jsx)(n.code,{children:"eventNames"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventsignature",children:"eventSignature()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventSignature"}),"(",(0,s.jsx)(n.code,{children:"event"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,s.jsx)(n.code,{children:"SimpleListener"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#getmaxlisteners",children:(0,s.jsx)(n.code,{children:"getMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlecollect",children:"handleCollect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleCollect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to handle an event as a collectable element. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-1",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#collect"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#handlecollect",children:(0,s.jsx)(n.code,{children:"handleCollect"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handledispose",children:"handleDispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleDispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to remove an element from the collection. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-2",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#dispose"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#handledispose",children:(0,s.jsx)(n.code,{children:"handleDispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listenercount",children:(0,s.jsx)(n.code,{children:"listenerCount"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listeners",children:(0,s.jsx)(n.code,{children:"listeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"off"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#off",children:(0,s.jsx)(n.code,{children:"off"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#on",children:(0,s.jsx)(n.code,{children:"on"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#prependlistener",children:(0,s.jsx)(n.code,{children:"prependListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"})," to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#prependoncelistener",children:(0,s.jsx)(n.code,{children:"prependOnceListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rawListeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,s.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-11",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#rawlisteners",children:(0,s.jsx)(n.code,{children:"rawListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,s.jsx)(n.code,{children:"event"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event?"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-12",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#removealllisteners",children:(0,s.jsx)(n.code,{children:"removeAllListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes the specified ",(0,s.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,s.jsx)(n.code,{children:"eventName"}),", then ",(0,s.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,s.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,s.jsx)(n.code,{children:"removeListener()"})," or ",(0,s.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,s.jsx)(n.em,{children:"after"})," emitting and ",(0,s.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,s.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,s.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,s.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,s.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,s.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,s.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-13",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#removelistener",children:(0,s.jsx)(n.code,{children:"removeListener"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resettimer",children:"resetTimer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"resetTimer"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Resets the collectors timeout and idle timer."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"})," = ",(0,s.jsx)(n.code,{children:"..."})]}),"\n",(0,s.jsx)(n.p,{children:"Options"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.idle?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to stop the collector after inactivity in milliseconds"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.time?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to run the collector for in milliseconds"}),"\n",(0,s.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#resettimer",children:(0,s.jsx)(n.code,{children:"resetTimer"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setimmediate",children:"setImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setImmediate"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an immediate that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Immediate"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setimmediate",children:(0,s.jsx)(n.code,{children:"setImmediate"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setinterval",children:"setInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setInterval"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an interval that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait between executions (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setinterval",children:(0,s.jsx)(n.code,{children:"setInterval"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["By default ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,s.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,s.jsx)(n.code,{children:"Infinity"})," (or ",(0,s.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-14",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setmaxlisteners",children:(0,s.jsx)(n.code,{children:"setMaxListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settimeout",children:"setTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setTimeout"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets a timeout that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait before executing (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#settimeout",children:(0,s.jsx)(n.code,{children:"setTimeout"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"reason"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Stops this collector and emits the ",(0,s.jsx)(n.code,{children:"end"})," event."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"reason?"}),": ",(0,s.jsx)(n.code,{children:"string"})," = ",(0,s.jsx)(n.code,{children:"'user'"})]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector is ending"}),"\n",(0,s.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"emits-3",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#end"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#stop",children:(0,s.jsx)(n.code,{children:"stop"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"wraphandler",children:"wrapHandler()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"wrapHandler"}),"(",(0,s.jsx)(n.code,{children:"handler"}),"): (",(0,s.jsx)(n.code,{children:"__namedParameters"}),") => ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"handler"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Function"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"__namedParameters"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"__namedParameters.data"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"name"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,s.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-15",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#geteventlisteners",children:(0,s.jsx)(n.code,{children:"getEventListeners"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount-1",children:(0,s.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,s.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,s.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-16",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,s.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,s.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,s.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#listenercount-1",children:(0,s.jsx)(n.code,{children:"listenerCount"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns an ",(0,s.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,s.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,s.jsx)(n.code,{children:"emitter"})]}),"\n",(0,s.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#on-1",children:(0,s.jsx)(n.code,{children:"on"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Creates a ",(0,s.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,s.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,s.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,s.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,s.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,s.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The special handling of the ",(0,s.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,s.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,s.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,s.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"since-18",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once-1",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#once-1",children:(0,s.jsx)(n.code,{children:"once"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"?, ...",(0,s.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n?"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,s.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-40",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"since-19",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})}),".",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#setmaxlisteners-1",children:(0,s.jsx)(n.code,{children:"setMaxListeners"})})]})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>t});var s=r(6540);const l={},c=s.createContext(l);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ee4cc26.3000370b.js b/assets/js/8ee4cc26.3000370b.js deleted file mode 100644 index 494ad89f2a..0000000000 --- a/assets/js/8ee4cc26.3000370b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8563],{1856:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>n,default:()=>P,frontMatter:()=>t,metadata:()=>a,toc:()=>p});var o=r(4848),c=r(8453);const t={},n="Type Alias: MPConfigType",a={id:"reference/structures/preProcessors/type-aliases/MPConfigType",title:"Type Alias: MPConfigType",description:"MPConfigType: PREPROCESSORS \\| MessagePreProcessor \\| (PREPROCESSORS \\| MessagePreProcessor)[]",source:"@site/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",sourceDirName:"reference/structures/preProcessors/type-aliases",slug:"/reference/structures/preProcessors/type-aliases/MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS"},next:{title:"Type Alias: MessagePreProcessor()",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor"}},i={},p=[];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"type-alias-mpconfigtype",children:"Type Alias: MPConfigType"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"MPConfigType"}),": ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:(0,o.jsx)(s.code,{children:"PREPROCESSORS"})})," | ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})})," | (",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:(0,o.jsx)(s.code,{children:"PREPROCESSORS"})})," | ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})}),")[]"]}),"\n"]}),"\n",(0,o.jsxs)(s.p,{children:["The actual type for ",(0,o.jsx)(s.a,{href:"/docs/api/interfaces/api_model_config.ConfigObject#messagepreprocessor",children:"config.messagePreprocessor"})]})]})}function P(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>a});var o=r(6540);const c={},t=o.createContext(c);function n(e){const s=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:n(e.components),o.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ee4cc26.a5cff998.js b/assets/js/8ee4cc26.a5cff998.js new file mode 100644 index 0000000000..b2e902693f --- /dev/null +++ b/assets/js/8ee4cc26.a5cff998.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8563],{1856:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>n,default:()=>d,frontMatter:()=>t,metadata:()=>a,toc:()=>p});var o=r(4848),c=r(8453);const t={},n="Type Alias: MPConfigType",a={id:"reference/structures/preProcessors/type-aliases/MPConfigType",title:"Type Alias: MPConfigType",description:"MPConfigType: PREPROCESSORS \\| MessagePreProcessor \\| (PREPROCESSORS \\| MessagePreProcessor)[]",source:"@site/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",sourceDirName:"reference/structures/preProcessors/type-aliases",slug:"/reference/structures/preProcessors/type-aliases/MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS"},next:{title:"Type Alias: MessagePreProcessor()",permalink:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor"}},i={},p=[];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"type-alias-mpconfigtype",children:"Type Alias: MPConfigType"})}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"MPConfigType"}),": ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:(0,o.jsx)(s.code,{children:"PREPROCESSORS"})})," | ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})})," | (",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:(0,o.jsx)(s.code,{children:"PREPROCESSORS"})})," | ",(0,o.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:(0,o.jsx)(s.code,{children:"MessagePreProcessor"})}),")[]"]}),"\n"]}),"\n",(0,o.jsxs)(s.p,{children:["The actual type for ",(0,o.jsx)(s.a,{href:"/docs/api/interfaces/api_model_config.ConfigObject#messagepreprocessor",children:"config.messagePreprocessor"})]})]})}function d(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>n,x:()=>a});var o=r(6540);const c={},t=o.createContext(c);function n(e){const s=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:n(e.components),o.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8fbd3a7f.3bac74b1.js b/assets/js/8fbd3a7f.3bac74b1.js deleted file mode 100644 index b350818c03..0000000000 --- a/assets/js/8fbd3a7f.3bac74b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9596],{6327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>o,frontMatter:()=>c,metadata:()=>l,toc:()=>h});var i=s(4848),r=s(8453);const c={},d="Interface: BaseChat",l={id:"reference/api/model/chat/interfaces/BaseChat",title:"Interface: BaseChat",description:"Extended by",source:"@site/docs/reference/api/model/chat/interfaces/BaseChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/BaseChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes"},next:{title:"Interface: GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat"}},t={},h=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"archive",id:"archive",level:3},{value:"canSend?",id:"cansend",level:3},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"contact",id:"contact",level:3},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"kind",id:"kind",level:3},{value:"labels",id:"labels",level:3},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"msgs",id:"msgs",level:3},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"name",id:"name",level:3},{value:"notSpam",id:"notspam",level:3},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"pic?",id:"pic",level:3},{value:"pin",id:"pin",level:3},{value:"presence",id:"presence",level:3},{value:"t",id:"t",level:3},{value:"unreadCount",id:"unreadcount",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-basechat",children:"Interface: BaseChat"}),"\n",(0,i.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:(0,i.jsx)(n.code,{children:"SingleChat"})})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:(0,i.jsx)(n.code,{children:"GroupChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"})]})}function o(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>l});var i=s(6540);const r={},c=i.createContext(r);function d(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8fbd3a7f.78c6e3ec.js b/assets/js/8fbd3a7f.78c6e3ec.js new file mode 100644 index 0000000000..52a142aebb --- /dev/null +++ b/assets/js/8fbd3a7f.78c6e3ec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9596],{6327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>o,frontMatter:()=>c,metadata:()=>l,toc:()=>h});var i=s(4848),r=s(8453);const c={},d="Interface: BaseChat",l={id:"reference/api/model/chat/interfaces/BaseChat",title:"Interface: BaseChat",description:"Extended by",source:"@site/docs/reference/api/model/chat/interfaces/BaseChat.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/BaseChat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes"},next:{title:"Interface: GroupChat",permalink:"/docs/reference/api/model/chat/interfaces/GroupChat"}},t={},h=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"archive",id:"archive",level:3},{value:"canSend?",id:"cansend",level:3},{value:"changeNumberNewJid",id:"changenumbernewjid",level:3},{value:"changeNumberOldJid",id:"changenumberoldjid",level:3},{value:"contact",id:"contact",level:3},{value:"formattedTitle?",id:"formattedtitle",level:3},{value:"groupMetadata",id:"groupmetadata",level:3},{value:"isAnnounceGrpRestrict",id:"isannouncegrprestrict",level:3},{value:"isOnline?",id:"isonline",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"isReadOnly",id:"isreadonly",level:3},{value:"kind",id:"kind",level:3},{value:"labels",id:"labels",level:3},{value:"lastReceivedKey",id:"lastreceivedkey",level:3},{value:"lastSeen?",id:"lastseen",level:3},{value:"Deprecated",id:"deprecated-1",level:4},{value:"modifyTag",id:"modifytag",level:3},{value:"msgs",id:"msgs",level:3},{value:"muteExpiration",id:"muteexpiration",level:3},{value:"name",id:"name",level:3},{value:"notSpam",id:"notspam",level:3},{value:"pendingMsgs",id:"pendingmsgs",level:3},{value:"pic?",id:"pic",level:3},{value:"pin",id:"pin",level:3},{value:"presence",id:"presence",level:3},{value:"t",id:"t",level:3},{value:"unreadCount",id:"unreadcount",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-basechat",children:"Interface: BaseChat"})}),"\n",(0,i.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:(0,i.jsx)(n.code,{children:"SingleChat"})})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:(0,i.jsx)(n.code,{children:"GroupChat"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ack"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"archive",children:"archive"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"archive"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cansend",children:"canSend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"canSend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether your host account is able to send messages to this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumbernewjid",children:"changeNumberNewJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberNewJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changenumberoldjid",children:"changeNumberOldJid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"changeNumberOldJid"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"contact",children:"contact"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"contact"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(n.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The contact related to this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"formattedtitle",children:"formattedTitle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"formattedTitle"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The title of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupmetadata",children:"groupMetadata"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"groupMetadata"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,i.jsx)(n.code,{children:"GroupMetadata"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Group metadata for this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isannouncegrprestrict",children:"isAnnounceGrpRestrict"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isAnnounceGrpRestrict"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the chat is a group chat is restricted"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isonline",children:(0,i.jsx)(n.del,{children:"isOnline?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isOnline"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline",children:(0,i.jsx)(n.code,{children:"isChatOnline"})})," instead."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is a group chat and the group is restricted"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The labels attached to this chat."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastreceivedkey",children:"lastReceivedKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"lastReceivedKey"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The ID of the last message received in this chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lastseen",children:(0,i.jsx)(n.del,{children:"lastSeen?"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lastSeen"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["This is unreliable. Use the method ",(0,i.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen",children:(0,i.jsx)(n.code,{children:"getLastSeen"})})," instead."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"modifytag",children:"modifyTag"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"modifyTag"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"msgs",children:"msgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"msgs"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The messages in the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"muteexpiration",children:"muteExpiration"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"muteExpiration"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The expiration timestamp of the chat mute"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name of the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"notspam",children:"notSpam"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"notSpam"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is marked as spam"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pendingmsgs",children:"pendingMsgs"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pendingMsgs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Messages that are pending to be sent"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pic",children:"pic?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pic"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"URL of the chat picture if available"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pin",children:"pin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pin"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the chat is pinned"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"presence",children:"presence"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"presence"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The presence state of the chat participant"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"t"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The timestamp of the last interaction in the chat"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"unreadcount",children:"unreadCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"unreadCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of undread messages in this chat"})]})}function o(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>l});var i=s(6540);const r={},c=i.createContext(r);function d(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/901c4e03.883b6175.js b/assets/js/901c4e03.883b6175.js deleted file mode 100644 index 24ee3051cf..0000000000 --- a/assets/js/901c4e03.883b6175.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1302],{269:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var r=n(4848),o=n(8453);const a={},i="Creating an API",s={id:"how-to/create-api",title:"Creating an API",description:"There are multiple convinient ways to create an API.",source:"@site/docs/how-to/create-api.md",sourceDirName:"how-to",slug:"/how-to/create-api",permalink:"/docs/how-to/create-api",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/create-api.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.71.15",permalink:"/docs/api/"},next:{title:"Decrypting Media",permalink:"/docs/how-to/decrypt-media"}},c={},d=[];function l(e){const t={h1:"h1",li:"li",ol:"ol",p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"creating-an-api",children:"Creating an API"}),"\n",(0,r.jsx)(t.p,{children:"There are multiple convinient ways to create an API."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Use the ready-made API via npx"}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"Learn more here [[Easy API]]"}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Build your own API on express and just use the built in middleware"}),"\n"]}),"\n",(0,r.jsx)(t.li,{}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>s});var r=n(6540);const o={},a=r.createContext(o);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/901c4e03.d86f43a0.js b/assets/js/901c4e03.d86f43a0.js new file mode 100644 index 0000000000..625fcb2d24 --- /dev/null +++ b/assets/js/901c4e03.d86f43a0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1302],{269:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var r=n(4848),a=n(8453);const o={},i="Creating an API",s={id:"how-to/create-api",title:"Creating an API",description:"There are multiple convinient ways to create an API.",source:"@site/docs/how-to/create-api.md",sourceDirName:"how-to",slug:"/how-to/create-api",permalink:"/docs/how-to/create-api",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/create-api.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.71.15",permalink:"/docs/api/"},next:{title:"Decrypting Media",permalink:"/docs/how-to/decrypt-media"}},c={},d=[];function l(e){const t={h1:"h1",header:"header",li:"li",ol:"ol",p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"creating-an-api",children:"Creating an API"})}),"\n",(0,r.jsx)(t.p,{children:"There are multiple convinient ways to create an API."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Use the ready-made API via npx"}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"Learn more here [[Easy API]]"}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Build your own API on express and just use the built in middleware"}),"\n"]}),"\n",(0,r.jsx)(t.li,{}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>s});var r=n(6540);const a={},o=r.createContext(a);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91a766d9.b753baa1.js b/assets/js/91a766d9.b753baa1.js new file mode 100644 index 0000000000..f83f66ec1d --- /dev/null +++ b/assets/js/91a766d9.b753baa1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2392],{6522:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var t=s(4848),i=s(8453);const o={},r="Multiple Sessions",a={id:"configuration/multiple-sessions",title:"Multiple Sessions",description:"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:",source:"@site/docs/configuration/multiple-sessions.md",sourceDirName:"configuration",slug:"/configuration/multiple-sessions",permalink:"/docs/configuration/multiple-sessions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/multiple-sessions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Licensed Features",permalink:"/docs/configuration/licensed-features"},next:{title:"Tutorial - Basics",permalink:"/docs/category/tutorial---basics"}},c={},l=[{value:"Orchestrating multiple sessions",id:"orchestrating-multiple-sessions",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"multiple-sessions",children:"Multiple Sessions"})}),"\n",(0,t.jsx)(n.p,{children:"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Design and run automated tests for you WA bot."}),"\n",(0,t.jsx)(n.li,{children:"Connect two or more WA numbers to a single (or multiple) message handler(s)"}),"\n",(0,t.jsx)(n.li,{children:"Use one client to make sure another one is alive by pinging it."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Please see demo/index.ts for a working example"}),"\n",(0,t.jsx)(n.p,{children:"NOTE: DO NOT CREATE TWO SESSIONS WITH THE SAME SESSIONID. DO NOT ALLOW SPACES AS SESSION ID."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { create, Client, ev} from '@open-wa/wa-automate';\n\nfunction start(client: Client) {\n ...\n}\n\ncreate({\n sessionId:'session'\n}).then(client => start(client));\n\ncreate({\n sessionId:'another_session'\n}).then(client => start(client));\n"})}),"\n",(0,t.jsx)(n.p,{children:"You can then capture the QR Code for each session using the following event listener code:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"//events are fired with the ev namespace then the session Id. e.g \"qr.another_session\"\n//You can however use the wildcard operator with the new event listener and capture the session Id as a parameter instead.\nev.on('qr.**', async (qrcode,sessionId) => {\n //base64 encoded qr code image\n const imageBuffer = Buffer.from(qrcode.replace('data:image/png;base64,',''), 'base64');\n fs.writeFileSync(`qr_code${sessionId?'_'+sessionId:''}.png`, imageBuffer);\n});\n"})}),"\n",(0,t.jsx)(n.h2,{id:"orchestrating-multiple-sessions",children:"Orchestrating multiple sessions"}),"\n",(0,t.jsx)(n.p,{children:"Client sessions are living breathing objects. They CANNOT be stringified and parsed for later use. If you want to 'hold' multiple sessions in one process, make sure to keep them in memory in a session object registry or array."}),"\n",(0,t.jsxs)(n.p,{children:["For example, let's say you have a ",(0,t.jsx)(n.code,{children:"marketing"})," and ",(0,t.jsx)(n.code,{children:"sales"})," sessions."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"...\n\nconst clientSessionRegistry = {};\n\nasync start(client){\n //save for later\n clientSessionRegistry[client.getSessionId()] = client;\n\n client.onMessage...\n}\n\n//maybe this is called from an API\nsendText(sessionId, params){\n //grab the existing client from the 'registry'\n const client = clientSessionRegistry[sessionId];\n\n //use the client\n client.sendText(...params);\n}\n\ncreate().then(client => start);\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var t=s(6540);const i={},o=t.createContext(i);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91a766d9.c02de747.js b/assets/js/91a766d9.c02de747.js deleted file mode 100644 index c1fc9cf26a..0000000000 --- a/assets/js/91a766d9.c02de747.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2392],{6522:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var t=s(4848),i=s(8453);const o={},r="Multiple Sessions",a={id:"configuration/multiple-sessions",title:"Multiple Sessions",description:"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:",source:"@site/docs/configuration/multiple-sessions.md",sourceDirName:"configuration",slug:"/configuration/multiple-sessions",permalink:"/docs/configuration/multiple-sessions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/multiple-sessions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Licensed Features",permalink:"/docs/configuration/licensed-features"},next:{title:"Tutorial - Basics",permalink:"/docs/category/tutorial---basics"}},c={},l=[{value:"Orchestrating multiple sessions",id:"orchestrating-multiple-sessions",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"multiple-sessions",children:"Multiple Sessions"}),"\n",(0,t.jsx)(n.p,{children:"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Design and run automated tests for you WA bot."}),"\n",(0,t.jsx)(n.li,{children:"Connect two or more WA numbers to a single (or multiple) message handler(s)"}),"\n",(0,t.jsx)(n.li,{children:"Use one client to make sure another one is alive by pinging it."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Please see demo/index.ts for a working example"}),"\n",(0,t.jsx)(n.p,{children:"NOTE: DO NOT CREATE TWO SESSIONS WITH THE SAME SESSIONID. DO NOT ALLOW SPACES AS SESSION ID."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { create, Client, ev} from '@open-wa/wa-automate';\n\nfunction start(client: Client) {\n ...\n}\n\ncreate({\n sessionId:'session'\n}).then(client => start(client));\n\ncreate({\n sessionId:'another_session'\n}).then(client => start(client));\n"})}),"\n",(0,t.jsx)(n.p,{children:"You can then capture the QR Code for each session using the following event listener code:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"//events are fired with the ev namespace then the session Id. e.g \"qr.another_session\"\n//You can however use the wildcard operator with the new event listener and capture the session Id as a parameter instead.\nev.on('qr.**', async (qrcode,sessionId) => {\n //base64 encoded qr code image\n const imageBuffer = Buffer.from(qrcode.replace('data:image/png;base64,',''), 'base64');\n fs.writeFileSync(`qr_code${sessionId?'_'+sessionId:''}.png`, imageBuffer);\n});\n"})}),"\n",(0,t.jsx)(n.h2,{id:"orchestrating-multiple-sessions",children:"Orchestrating multiple sessions"}),"\n",(0,t.jsx)(n.p,{children:"Client sessions are living breathing objects. They CANNOT be stringified and parsed for later use. If you want to 'hold' multiple sessions in one process, make sure to keep them in memory in a session object registry or array."}),"\n",(0,t.jsxs)(n.p,{children:["For example, let's say you have a ",(0,t.jsx)(n.code,{children:"marketing"})," and ",(0,t.jsx)(n.code,{children:"sales"})," sessions."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"...\n\nconst clientSessionRegistry = {};\n\nasync start(client){\n //save for later\n clientSessionRegistry[client.getSessionId()] = client;\n\n client.onMessage...\n}\n\n//maybe this is called from an API\nsendText(sessionId, params){\n //grab the existing client from the 'registry'\n const client = clientSessionRegistry[sessionId];\n\n //use the client\n client.sendText(...params);\n}\n\ncreate().then(client => start);\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var t=s(6540);const i={},o=t.createContext(i);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/925b3f96.680d26b7.js b/assets/js/925b3f96.680d26b7.js deleted file mode 100644 index 64200477da..0000000000 --- a/assets/js/925b3f96.680d26b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8609],{5026:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>n,contentTitle:()=>a,default:()=>m,frontMatter:()=>r,metadata:()=>u,toc:()=>l});var s=o(4848),i=o(8453);const r={slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},a=void 0,u={permalink:"/blog/first-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md",source:"@site/blog/2019-05-28-first-blog-post.md",title:"First Blog Post",description:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet",date:"2019-05-28T00:00:00.000Z",tags:[{inline:!1,label:"Hola",permalink:"/blog/tags/hola",description:"Hola tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.12,hasTruncateMarker:!1,authors:[{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"}],frontMatter:{slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},unlisted:!1,prevItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},n={authorsImageUrls:[void 0]},l=[];function c(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,s.jsx)(e.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})}function m(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(c,{...t})}):c(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>u});var s=o(6540);const i={},r=s.createContext(i);function a(t){const e=s.useContext(r);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function u(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:a(t.components),s.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/925b3f96.7a10af78.js b/assets/js/925b3f96.7a10af78.js new file mode 100644 index 0000000000..bbff41e282 --- /dev/null +++ b/assets/js/925b3f96.7a10af78.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8609],{5026:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>n,contentTitle:()=>a,default:()=>m,frontMatter:()=>u,metadata:()=>r,toc:()=>l});var s=o(4848),i=o(8453);const u={slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},a=void 0,r={permalink:"/blog/first-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md",source:"@site/blog/2019-05-28-first-blog-post.md",title:"First Blog Post",description:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet",date:"2019-05-28T00:00:00.000Z",tags:[{inline:!1,label:"Hola",permalink:"/blog/tags/hola",description:"Hola tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.12,hasTruncateMarker:!1,authors:[{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png",key:null,page:null}],frontMatter:{slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},unlisted:!1,prevItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},n={authorsImageUrls:[void 0]},l=[];function c(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,s.jsx)(e.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})}function m(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(c,{...t})}):c(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>r});var s=o(6540);const i={},u=s.createContext(i);function a(t){const e=s.useContext(u);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:a(t.components),s.createElement(u.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/9403ec86.0ab4953e.js b/assets/js/9403ec86.0ab4953e.js new file mode 100644 index 0000000000..43d14a78de --- /dev/null +++ b/assets/js/9403ec86.0ab4953e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3689],{1204:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>n,metadata:()=>c,toc:()=>l});var r=s(4848),i=s(8453);const n={},o="Interface: DialogListMessageSection",c={id:"reference/structures/Dialog/interfaces/DialogListMessageSection",title:"Interface: DialogListMessageSection",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow"},next:{title:"Interface: DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"rows",id:"rows",level:3},{value:"title",id:"title",level:3}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-dialoglistmessagesection",children:"Interface: DialogListMessageSection"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"rows",children:"rows"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rows"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",children:(0,r.jsx)(t.code,{children:"DialogListMessageRow"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var r=s(6540);const i={},n=r.createContext(i);function o(e){const t=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9403ec86.c3497bb6.js b/assets/js/9403ec86.c3497bb6.js deleted file mode 100644 index 520831e7c3..0000000000 --- a/assets/js/9403ec86.c3497bb6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3689],{1204:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>n,metadata:()=>c,toc:()=>l});var r=s(4848),i=s(8453);const n={},o="Interface: DialogListMessageSection",c={id:"reference/structures/Dialog/interfaces/DialogListMessageSection",title:"Interface: DialogListMessageSection",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogListMessageRow",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow"},next:{title:"Interface: DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"rows",id:"rows",level:3},{value:"title",id:"title",level:3}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-dialoglistmessagesection",children:"Interface: DialogListMessageSection"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"rows",children:"rows"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"rows"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",children:(0,r.jsx)(t.code,{children:"DialogListMessageRow"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"title",children:"title"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"title"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var r=s(6540);const i={},n=r.createContext(i);function o(e){const t=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9462.91d3ebca.js b/assets/js/9462.91d3ebca.js deleted file mode 100644 index 2dc53f3f59..0000000000 --- a/assets/js/9462.91d3ebca.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9462],{9462:(e,t,r)=>{function n(e,t){var r=void 0;return function(){for(var n=arguments.length,o=new Array(n),i=0;ivn});var a=function(){};function c(e){var t=e.item,r=e.items;return{index:t.__autocomplete_indexName,items:[t],positions:[1+r.findIndex((function(e){return e.objectID===t.objectID}))],queryID:t.__autocomplete_queryID,algoliaSource:["autocomplete"]}}function l(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,o,i,a,c=[],l=!0,u=!1;try{if(i=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;l=!1}else for(;!(l=(n=i.call(r)).done)&&(c.push(n.value),c.length!==t);l=!0);}catch(s){u=!0,o=s}finally{try{if(!l&&null!=r.return&&(a=r.return(),Object(a)!==a))return}finally{if(u)throw o}}return c}}(e,t)||function(e,t){if(!e)return;if("string"==typeof e)return u(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return u(e,t)}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function u(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);re.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function y(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function h(e){for(var t=1;t=3||2===r&&n>=4||1===r&&n>=10);function i(t,r,n){if(o&&void 0!==n){var i=n[0].__autocomplete_algoliaCredentials,a={"X-Algolia-Application-Id":i.appId,"X-Algolia-API-Key":i.apiKey};e.apply(void 0,[t].concat(p(r),[{headers:a}]))}else e.apply(void 0,[t].concat(p(r)))}return{init:function(t,r){e("init",{appId:t,apiKey:r})},setUserToken:function(t){e("setUserToken",t)},clickedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),r=0;r0&&i("clickedObjectIDsAfterSearch",g(t),t[0].items)},clickedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),r=0;r0&&i("clickedObjectIDs",g(t),t[0].items)},clickedFilters:function(){for(var t=arguments.length,r=new Array(t),n=0;n0&&e.apply(void 0,["clickedFilters"].concat(r))},convertedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),r=0;r0&&i("convertedObjectIDsAfterSearch",g(t),t[0].items)},convertedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),r=0;r0&&i("convertedObjectIDs",g(t),t[0].items)},convertedFilters:function(){for(var t=arguments.length,r=new Array(t),n=0;n0&&e.apply(void 0,["convertedFilters"].concat(r))},viewedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),r=0;r0&&t.reduce((function(e,t){var r=t.items,n=d(t,f);return[].concat(p(e),p(function(e){for(var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:20,r=[],n=0;n0&&e.apply(void 0,["viewedFilters"].concat(r))}}}function S(e){var t=e.items.reduce((function(e,t){var r;return e[t.__autocomplete_indexName]=(null!==(r=e[t.__autocomplete_indexName])&&void 0!==r?r:[]).concat(t),e}),{});return Object.keys(t).map((function(e){return{index:e,items:t[e],algoliaSource:["autocomplete"]}}))}function j(e){return e.objectID&&e.__autocomplete_indexName&&e.__autocomplete_queryID}function w(e){return w="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},w(e)}function E(e){return function(e){if(Array.isArray(e))return P(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return P(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return P(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function P(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r0&&C({onItemsChange:o,items:r,insights:f,state:t}))}}),0);return{name:"aa.algoliaInsightsPlugin",subscribe:function(e){var t=e.setContext,r=e.onSelect,n=e.onActive;s("addAlgoliaAgent","insights-plugin"),t({algoliaInsightsPlugin:{__algoliaSearchParameters:{clickAnalytics:!0},insights:f}}),r((function(e){var t=e.item,r=e.state,n=e.event;j(t)&&l({state:r,event:n,insights:f,item:t,insightsEvents:[D({eventName:"Item Selected"},c({item:t,items:m.current}))]})})),n((function(e){var t=e.item,r=e.state,n=e.event;j(t)&&u({state:r,event:n,insights:f,item:t,insightsEvents:[D({eventName:"Item Active"},c({item:t,items:m.current}))]})}))},onStateChange:function(e){var t=e.state;p({state:t})},__autocomplete_pluginOptions:e}}function _(e){return _="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},_(e)}function T(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function q(e,t,r){return(t=function(e){var t=function(e,t){if("object"!==_(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!==_(n))return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"===_(t)?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function R(e,t,r){var n,o=t.initialState;return{getState:function(){return o},dispatch:function(n,i){var a=function(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r0},reshape:function(e){return e.sources}},e),{},{id:null!==(r=e.id)&&void 0!==r?r:"autocomplete-".concat(V++),plugins:o,initialState:X({activeItemId:null,query:"",completion:null,collections:[],isOpen:!1,status:"idle",context:{}},e.initialState),onStateChange:function(t){var r;null===(r=e.onStateChange)||void 0===r||r.call(e,t),o.forEach((function(e){var r;return null===(r=e.onStateChange)||void 0===r?void 0:r.call(e,t)}))},onSubmit:function(t){var r;null===(r=e.onSubmit)||void 0===r||r.call(e,t),o.forEach((function(e){var r;return null===(r=e.onSubmit)||void 0===r?void 0:r.call(e,t)}))},onReset:function(t){var r;null===(r=e.onReset)||void 0===r||r.call(e,t),o.forEach((function(e){var r;return null===(r=e.onReset)||void 0===r?void 0:r.call(e,t)}))},getSources:function(r){return Promise.all([].concat(Q(o.map((function(e){return e.getSources}))),[e.getSources]).filter(Boolean).map((function(e){return function(e,t){var r=[];return Promise.resolve(e(t)).then((function(e){return Array.isArray(e),Promise.all(e.filter((function(e){return Boolean(e)})).map((function(e){if(e.sourceId,r.includes(e.sourceId))throw new Error("[Autocomplete] The `sourceId` ".concat(JSON.stringify(e.sourceId)," is not unique."));r.push(e.sourceId);var t={getItemInputValue:function(e){return e.state.query},getItemUrl:function(){},onSelect:function(e){(0,e.setIsOpen)(!1)},onActive:a,onResolve:a};Object.keys(t).forEach((function(e){t[e].__default=!0}));var n=$($({},t),e);return Promise.resolve(n)})))}))}(e,r)}))).then((function(e){return L(e)})).then((function(e){return e.map((function(e){return X(X({},e),{},{onSelect:function(r){e.onSelect(r),t.forEach((function(e){var t;return null===(t=e.onSelect)||void 0===t?void 0:t.call(e,r)}))},onActive:function(r){e.onActive(r),t.forEach((function(e){var t;return null===(t=e.onActive)||void 0===t?void 0:t.call(e,r)}))},onResolve:function(r){e.onResolve(r),t.forEach((function(e){var t;return null===(t=e.onResolve)||void 0===t?void 0:t.call(e,r)}))}})}))}))},navigator:X({navigate:function(e){var t=e.itemUrl;n.location.assign(t)},navigateNewTab:function(e){var t=e.itemUrl,r=n.open(t,"_blank","noopener");null==r||r.focus()},navigateNewWindow:function(e){var t=e.itemUrl;n.open(t,"_blank","noopener")}},e.navigator)})}function te(e){return te="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},te(e)}function re(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function ne(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var Ie,De,Ae,ke=null,xe=(Ie=-1,De=-1,Ae=void 0,function(e){var t=++Ie;return Promise.resolve(e).then((function(e){return Ae&&t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var Me=/((gt|sm)-|galaxy nexus)|samsung[- ]|samsungbrowser/i;function He(e){return He="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},He(e)}var Fe=["props","refresh","store"],Ue=["inputElement","formElement","panelElement"],Be=["inputElement"],Ve=["inputElement","maxLength"],Ke=["sourceIndex"],$e=["sourceIndex"],Je=["item","source","sourceIndex"];function ze(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function We(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function Ge(e){var t=e.props,r=e.refresh,n=e.store,o=Ze(e,Fe),i=function(e,t){return void 0!==t?"".concat(e,"-").concat(t):e};return{getEnvironmentProps:function(e){var r=e.inputElement,o=e.formElement,i=e.panelElement;function a(e){!n.getState().isOpen&&n.pendingRequests.isEmpty()||e.target===r||!1===[o,i].some((function(t){return r=t,n=e.target,r===n||r.contains(n);var r,n}))&&(n.dispatch("blur",null),t.debug||n.pendingRequests.cancelAll())}return We({onTouchStart:a,onMouseDown:a,onTouchMove:function(e){!1!==n.getState().isOpen&&r===t.environment.document.activeElement&&e.target!==r&&r.blur()}},Ze(e,Ue))},getRootProps:function(e){return We({role:"combobox","aria-expanded":n.getState().isOpen,"aria-haspopup":"listbox","aria-owns":n.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label")},e)},getFormProps:function(e){e.inputElement;return We({action:"",noValidate:!0,role:"search",onSubmit:function(i){var a;i.preventDefault(),t.onSubmit(We({event:i,refresh:r,state:n.getState()},o)),n.dispatch("submit",null),null===(a=e.inputElement)||void 0===a||a.blur()},onReset:function(i){var a;i.preventDefault(),t.onReset(We({event:i,refresh:r,state:n.getState()},o)),n.dispatch("reset",null),null===(a=e.inputElement)||void 0===a||a.focus()}},Ze(e,Be))},getLabelProps:function(e){var r=e||{},n=r.sourceIndex,o=Ze(r,Ke);return We({htmlFor:"".concat(i(t.id,n),"-input"),id:"".concat(i(t.id,n),"-label")},o)},getInputProps:function(e){var i;function c(e){(t.openOnFocus||Boolean(n.getState().query))&&Ce(We({event:e,props:t,query:n.getState().completion||n.getState().query,refresh:r,store:n},o)),n.dispatch("focus",null)}var l=e||{},u=(l.inputElement,l.maxLength),s=void 0===u?512:u,f=Ze(l,Ve),m=ge(n.getState()),p=function(e){return Boolean(e&&e.match(Me))}((null===(i=t.environment.navigator)||void 0===i?void 0:i.userAgent)||""),v=null!=m&&m.itemUrl&&!p?"go":"search";return We({"aria-autocomplete":"both","aria-activedescendant":n.getState().isOpen&&null!==n.getState().activeItemId?"".concat(t.id,"-item-").concat(n.getState().activeItemId):void 0,"aria-controls":n.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label"),value:n.getState().completion||n.getState().query,id:"".concat(t.id,"-input"),autoComplete:"off",autoCorrect:"off",autoCapitalize:"off",enterKeyHint:v,spellCheck:"false",autoFocus:t.autoFocus,placeholder:t.placeholder,maxLength:s,type:"search",onChange:function(e){Ce(We({event:e,props:t,query:e.currentTarget.value.slice(0,s),refresh:r,store:n},o))},onKeyDown:function(e){!function(e){var t=e.event,r=e.props,n=e.refresh,o=e.store,i=Le(e,_e);if("ArrowUp"===t.key||"ArrowDown"===t.key){var a=function(){var e=r.environment.document.getElementById("".concat(r.id,"-item-").concat(o.getState().activeItemId));e&&(e.scrollIntoViewIfNeeded?e.scrollIntoViewIfNeeded(!1):e.scrollIntoView(!1))},c=function(){var e=ge(o.getState());if(null!==o.getState().activeItemId&&e){var r=e.item,a=e.itemInputValue,c=e.itemUrl,l=e.source;l.onActive(qe({event:t,item:r,itemInputValue:a,itemUrl:c,refresh:n,source:l,state:o.getState()},i))}};t.preventDefault(),!1===o.getState().isOpen&&(r.openOnFocus||Boolean(o.getState().query))?Ce(qe({event:t,props:r,query:o.getState().query,refresh:n,store:o},i)).then((function(){o.dispatch(t.key,{nextActiveItemId:r.defaultActiveItemId}),c(),setTimeout(a,0)})):(o.dispatch(t.key,{}),c(),a())}else if("Escape"===t.key)t.preventDefault(),o.dispatch(t.key,null),o.pendingRequests.cancelAll();else if("Tab"===t.key)o.dispatch("blur",null),o.pendingRequests.cancelAll();else if("Enter"===t.key){if(null===o.getState().activeItemId||o.getState().collections.every((function(e){return 0===e.items.length})))return void(r.debug||o.pendingRequests.cancelAll());t.preventDefault();var l=ge(o.getState()),u=l.item,s=l.itemInputValue,f=l.itemUrl,m=l.source;if(t.metaKey||t.ctrlKey)void 0!==f&&(m.onSelect(qe({event:t,item:u,itemInputValue:s,itemUrl:f,refresh:n,source:m,state:o.getState()},i)),r.navigator.navigateNewTab({itemUrl:f,item:u,state:o.getState()}));else if(t.shiftKey)void 0!==f&&(m.onSelect(qe({event:t,item:u,itemInputValue:s,itemUrl:f,refresh:n,source:m,state:o.getState()},i)),r.navigator.navigateNewWindow({itemUrl:f,item:u,state:o.getState()}));else if(t.altKey);else{if(void 0!==f)return m.onSelect(qe({event:t,item:u,itemInputValue:s,itemUrl:f,refresh:n,source:m,state:o.getState()},i)),void r.navigator.navigate({itemUrl:f,item:u,state:o.getState()});Ce(qe({event:t,nextState:{isOpen:!1},props:r,query:s,refresh:n,store:o},i)).then((function(){m.onSelect(qe({event:t,item:u,itemInputValue:s,itemUrl:f,refresh:n,source:m,state:o.getState()},i))}))}}}(We({event:e,props:t,refresh:r,store:n},o))},onFocus:c,onBlur:a,onClick:function(r){e.inputElement!==t.environment.document.activeElement||n.getState().isOpen||c(r)}},f)},getPanelProps:function(e){return We({onMouseDown:function(e){e.preventDefault()},onMouseLeave:function(){n.dispatch("mouseleave",null)}},e)},getListProps:function(e){var r=e||{},n=r.sourceIndex,o=Ze(r,$e);return We({role:"listbox","aria-labelledby":"".concat(i(t.id,n),"-label"),id:"".concat(i(t.id,n),"-list")},o)},getItemProps:function(e){var a=e.item,c=e.source,l=e.sourceIndex,u=Ze(e,Je);return We({id:"".concat(i(t.id,l),"-item-").concat(a.__autocomplete_id),role:"option","aria-selected":n.getState().activeItemId===a.__autocomplete_id,onMouseMove:function(e){if(a.__autocomplete_id!==n.getState().activeItemId){n.dispatch("mousemove",a.__autocomplete_id);var t=ge(n.getState());if(null!==n.getState().activeItemId&&t){var i=t.item,c=t.itemInputValue,l=t.itemUrl,u=t.source;u.onActive(We({event:e,item:i,itemInputValue:c,itemUrl:l,refresh:r,source:u,state:n.getState()},o))}}},onMouseDown:function(e){e.preventDefault()},onClick:function(e){var i=c.getItemInputValue({item:a,state:n.getState()}),l=c.getItemUrl({item:a,state:n.getState()});(l?Promise.resolve():Ce(We({event:e,nextState:{isOpen:!1},props:t,query:i,refresh:r,store:n},o))).then((function(){c.onSelect(We({event:e,item:a,itemInputValue:i,itemUrl:l,refresh:r,source:c,state:n.getState()},o))}))}},u)}}}var Xe=[{segment:"autocomplete-core",version:"1.9.3"}];function Ye(e){return Ye="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Ye(e)}function et(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function tt(e){for(var t=1;t=r?null===n?null:0:o}function at(e){return at="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},at(e)}function ct(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function lt(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function kt(e){var t=e.translations,r=void 0===t?{}:t,n=At(e,Pt),o=r.noResultsText,i=void 0===o?"No results for":o,a=r.suggestedQueryText,c=void 0===a?"Try searching for":a,l=r.reportMissingResultsText,u=void 0===l?"Believe this query should return results?":l,s=r.reportMissingResultsLinkText,f=void 0===s?"Let us know.":s,m=n.state.context.searchSuggestions;return yt.createElement("div",{className:"DocSearch-NoResults"},yt.createElement("div",{className:"DocSearch-Screen-Icon"},yt.createElement(Et,null)),yt.createElement("p",{className:"DocSearch-Title"},i,' "',yt.createElement("strong",null,n.state.query),'"'),m&&m.length>0&&yt.createElement("div",{className:"DocSearch-NoResults-Prefill-List"},yt.createElement("p",{className:"DocSearch-Help"},c,":"),yt.createElement("ul",null,m.slice(0,3).reduce((function(e,t){return[].concat(It(e),[yt.createElement("li",{key:t},yt.createElement("button",{className:"DocSearch-Prefill",key:t,type:"button",onClick:function(){n.setQuery(t.toLowerCase()+" "),n.refresh(),n.inputRef.current.focus()}},t))])}),[]))),n.getMissingResultsUrl&&yt.createElement("p",{className:"DocSearch-Help"},"".concat(u," "),yt.createElement("a",{href:n.getMissingResultsUrl({query:n.state.query}),target:"_blank",rel:"noopener noreferrer"},f)))}var xt=function(){return yt.createElement("svg",{width:"20",height:"20",viewBox:"0 0 20 20"},yt.createElement("path",{d:"M17 6v12c0 .52-.2 1-1 1H4c-.7 0-1-.33-1-1V2c0-.55.42-1 1-1h8l5 5zM14 8h-3.13c-.51 0-.87-.34-.87-.87V4",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinejoin:"round"}))};function Ct(e){switch(e.type){case"lvl1":return yt.createElement(xt,null);case"content":return yt.createElement(_t,null);default:return yt.createElement(Nt,null)}}function Nt(){return yt.createElement("svg",{width:"20",height:"20",viewBox:"0 0 20 20"},yt.createElement("path",{d:"M13 13h4-4V8H7v5h6v4-4H7V8H3h4V3v5h6V3v5h4-4v5zm-6 0v4-4H3h4z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"}))}function _t(){return yt.createElement("svg",{width:"20",height:"20",viewBox:"0 0 20 20"},yt.createElement("path",{d:"M17 5H3h14zm0 5H3h14zm0 5H3h14z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinejoin:"round"}))}function Tt(){return yt.createElement("svg",{className:"DocSearch-Hit-Select-Icon",width:"20",height:"20",viewBox:"0 0 20 20"},yt.createElement("g",{stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"},yt.createElement("path",{d:"M18 3v4c0 2-2 4-4 4H2"}),yt.createElement("path",{d:"M8 17l-6-6 6-6"})))}var qt=["hit","attribute","tagName"];function Rt(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function Lt(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function Ft(e,t){return t.split(".").reduce((function(e,t){return null!=e&&e[t]?e[t]:null}),e)}function Ut(e){var t=e.hit,r=e.attribute,n=e.tagName,o=void 0===n?"span":n,i=Ht(e,qt);return(0,yt.createElement)(o,Lt(Lt({},i),{},{dangerouslySetInnerHTML:{__html:Ft(t,"_snippetResult.".concat(r,".value"))||Ft(t,r)}}))}function Bt(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null==r)return;var n,o,i=[],a=!0,c=!1;try{for(r=r.call(e);!(a=(n=r.next()).done)&&(i.push(n.value),!t||i.length!==t);a=!0);}catch(l){c=!0,o=l}finally{try{a||null==r.return||r.return()}finally{if(c)throw o}}return i}(e,t)||function(e,t){if(!e)return;if("string"==typeof e)return Vt(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return Vt(e,t)}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function Vt(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r|<\/mark>)/g,Wt=RegExp(zt.source);function Qt(e){var t,r,n=e;if(!n.__docsearch_parent&&!e._highlightResult)return e.hierarchy.lvl0;var o=((n.__docsearch_parent?null===(t=n.__docsearch_parent)||void 0===t||null===(t=t._highlightResult)||void 0===t||null===(t=t.hierarchy)||void 0===t?void 0:t.lvl0:null===(r=e._highlightResult)||void 0===r||null===(r=r.hierarchy)||void 0===r?void 0:r.lvl0)||{}).value;return o&&Wt.test(o)?o.replace(zt,""):o}function Zt(){return Zt=Object.assign||function(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function or(e){var t=e.translations,r=void 0===t?{}:t,n=nr(e,tr),o=r.recentSearchesTitle,i=void 0===o?"Recent":o,a=r.noRecentSearchesText,c=void 0===a?"No recent searches":a,l=r.saveRecentSearchButtonTitle,u=void 0===l?"Save this search":l,s=r.removeRecentSearchButtonTitle,f=void 0===s?"Remove this search from history":s,m=r.favoriteSearchesTitle,p=void 0===m?"Favorite":m,v=r.removeFavoriteSearchButtonTitle,d=void 0===v?"Remove this search from favorites":v;return"idle"===n.state.status&&!1===n.hasCollections?n.disableUserPersonalization?null:yt.createElement("div",{className:"DocSearch-StartScreen"},yt.createElement("p",{className:"DocSearch-Help"},c)):!1===n.hasCollections?null:yt.createElement("div",{className:"DocSearch-Dropdown-Container"},yt.createElement($t,rr({},n,{title:i,collection:n.state.collections[0],renderIcon:function(){return yt.createElement("div",{className:"DocSearch-Hit-icon"},yt.createElement(Xt,null))},renderAction:function(e){var t=e.item,r=e.runFavoriteTransition,o=e.runDeleteTransition;return yt.createElement(yt.Fragment,null,yt.createElement("div",{className:"DocSearch-Hit-action"},yt.createElement("button",{className:"DocSearch-Hit-action-button",title:u,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),r((function(){n.favoriteSearches.add(t),n.recentSearches.remove(t),n.refresh()}))}},yt.createElement(Yt,null))),yt.createElement("div",{className:"DocSearch-Hit-action"},yt.createElement("button",{className:"DocSearch-Hit-action-button",title:f,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),o((function(){n.recentSearches.remove(t),n.refresh()}))}},yt.createElement(er,null))))}})),yt.createElement($t,rr({},n,{title:p,collection:n.state.collections[1],renderIcon:function(){return yt.createElement("div",{className:"DocSearch-Hit-icon"},yt.createElement(Yt,null))},renderAction:function(e){var t=e.item,r=e.runDeleteTransition;return yt.createElement("div",{className:"DocSearch-Hit-action"},yt.createElement("button",{className:"DocSearch-Hit-action-button",title:d,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),r((function(){n.favoriteSearches.remove(t),n.refresh()}))}},yt.createElement(er,null)))}})))}var ir=["translations"];function ar(){return ar=Object.assign||function(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var lr=yt.memo((function(e){var t=e.translations,r=void 0===t?{}:t,n=cr(e,ir);if("error"===n.state.status)return yt.createElement(wt,{translations:null==r?void 0:r.errorScreen});var o=n.state.collections.some((function(e){return e.items.length>0}));return n.state.query?!1===o?yt.createElement(kt,ar({},n,{translations:null==r?void 0:r.noResultsScreen})):yt.createElement(Gt,n):yt.createElement(or,ar({},n,{hasCollections:o,translations:null==r?void 0:r.startScreen}))}),(function(e,t){return"loading"===t.state.status||"stalled"===t.state.status}));function ur(){return yt.createElement("svg",{viewBox:"0 0 38 38",stroke:"currentColor",strokeOpacity:".5"},yt.createElement("g",{fill:"none",fillRule:"evenodd"},yt.createElement("g",{transform:"translate(1 1)",strokeWidth:"2"},yt.createElement("circle",{strokeOpacity:".3",cx:"18",cy:"18",r:"18"}),yt.createElement("path",{d:"M36 18c0-9.94-8.06-18-18-18"},yt.createElement("animateTransform",{attributeName:"transform",type:"rotate",from:"0 18 18",to:"360 18 18",dur:"1s",repeatCount:"indefinite"})))))}var sr=r(9188),fr=["translations"];function mr(){return mr=Object.assign||function(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function vr(e){var t=e.translations,r=void 0===t?{}:t,n=pr(e,fr),o=r.resetButtonTitle,i=void 0===o?"Clear the query":o,a=r.resetButtonAriaLabel,c=void 0===a?"Clear the query":a,l=r.cancelButtonText,u=void 0===l?"Cancel":l,s=r.cancelButtonAriaLabel,f=void 0===s?"Cancel":s,m=r.searchInputLabel,p=void 0===m?"Search":m,v=n.getFormProps({inputElement:n.inputRef.current}).onReset;return yt.useEffect((function(){n.autoFocus&&n.inputRef.current&&n.inputRef.current.focus()}),[n.autoFocus,n.inputRef]),yt.useEffect((function(){n.isFromSelection&&n.inputRef.current&&n.inputRef.current.select()}),[n.isFromSelection,n.inputRef]),yt.createElement(yt.Fragment,null,yt.createElement("form",{className:"DocSearch-Form",onSubmit:function(e){e.preventDefault()},onReset:v},yt.createElement("label",mr({className:"DocSearch-MagnifierLabel"},n.getLabelProps()),yt.createElement(sr.W,null),yt.createElement("span",{className:"DocSearch-VisuallyHiddenForAccessibility"},p)),yt.createElement("div",{className:"DocSearch-LoadingIndicator"},yt.createElement(ur,null)),yt.createElement("input",mr({className:"DocSearch-Input",ref:n.inputRef},n.getInputProps({inputElement:n.inputRef.current,autoFocus:n.autoFocus,maxLength:ht}))),yt.createElement("button",{type:"reset",title:i,className:"DocSearch-Reset","aria-label":c,hidden:!n.state.query},yt.createElement(er,null))),yt.createElement("button",{className:"DocSearch-Cancel",type:"reset","aria-label":f,onClick:n.onClose},u))}var dr=["_highlightResult","_snippetResult"];function yr(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},i=Object.keys(e);for(n=0;n=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function hr(e){return!1===function(){var e="__TEST_KEY__";try{return localStorage.setItem(e,""),localStorage.removeItem(e),!0}catch(t){return!1}}()?{setItem:function(){},getItem:function(){return[]}}:{setItem:function(t){return window.localStorage.setItem(e,JSON.stringify(t))},getItem:function(){var t=window.localStorage.getItem(e);return t?JSON.parse(t):[]}}}function br(e){var t=e.key,r=e.limit,n=void 0===r?5:r,o=hr(t),i=o.getItem().slice(0,n);return{add:function(e){var t=e,r=(t._highlightResult,t._snippetResult,yr(t,dr)),a=i.findIndex((function(e){return e.objectID===r.objectID}));a>-1&&i.splice(a,1),i.unshift(r),i=i.slice(0,n),o.setItem(i)},remove:function(e){i=i.filter((function(t){return t.objectID!==e.objectID})),o.setItem(i)},getAll:function(){return i}}}function gr(e){const t=`algoliasearch-client-js-${e.key}`;let r;const n=()=>(void 0===r&&(r=e.localStorage||window.localStorage),r),o=()=>JSON.parse(n().getItem(t)||"{}"),i=e=>{n().setItem(t,JSON.stringify(e))};return{get:(t,r,n={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{(()=>{const t=e.timeToLive?1e3*e.timeToLive:null,r=o(),n=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(i(n),!t)return;const a=Object.fromEntries(Object.entries(n).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+tPromise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||n.miss(e)]))).then((([e])=>e)),set:(e,r)=>Promise.resolve().then((()=>{const i=o();return i[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:r},n().setItem(t,JSON.stringify(i)),r})),delete:e=>Promise.resolve().then((()=>{const r=o();delete r[JSON.stringify(e)],n().setItem(t,JSON.stringify(r))})),clear:()=>Promise.resolve().then((()=>{n().removeItem(t)}))}}function Or(e){const t=[...e.caches],r=t.shift();return void 0===r?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,n,o={miss:()=>Promise.resolve()})=>r.get(e,n,o).catch((()=>Or({caches:t}).get(e,n,o))),set:(e,n)=>r.set(e,n).catch((()=>Or({caches:t}).set(e,n))),delete:e=>r.delete(e).catch((()=>Or({caches:t}).delete(e))),clear:()=>r.clear().catch((()=>Or({caches:t}).clear()))}}function Sr(e={serializable:!0}){let t={};return{get(r,n,o={miss:()=>Promise.resolve()}){const i=JSON.stringify(r);if(i in t)return Promise.resolve(e.serializable?JSON.parse(t[i]):t[i]);const a=n(),c=o&&o.miss||(()=>Promise.resolve());return a.then((e=>c(e))).then((()=>a))},set:(r,n)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(n):n,Promise.resolve(n)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}function jr(e){let t=e.length-1;for(;t>0;t--){const r=Math.floor(Math.random()*(t+1)),n=e[t];e[t]=e[r],e[r]=n}return e}function wr(e,t){return t?(Object.keys(t).forEach((r=>{e[r]=t[r](e)})),e):e}function Er(e,...t){let r=0;return e.replace(/%s/g,(()=>encodeURIComponent(t[r++])))}const Pr="4.24.0",Ir={WithinQueryParameters:0,WithinHeaders:1};function Dr(e,t){const r=e||{},n=r.data||{};return Object.keys(r).forEach((e=>{-1===["timeout","headers","queryParameters","data","cacheable"].indexOf(e)&&(n[e]=r[e])})),{data:Object.entries(n).length>0?n:void 0,timeout:r.timeout||t,headers:r.headers||{},queryParameters:r.queryParameters||{},cacheable:r.cacheable}}const Ar={Read:1,Write:2,Any:3},kr={Up:1,Down:2,Timeouted:3},xr=12e4;function Cr(e,t=kr.Up){return{...e,status:t,lastUpdate:Date.now()}}function Nr(e){return"string"==typeof e?{protocol:"https",url:e,accept:Ar.Any}:{protocol:e.protocol||"https",url:e.url,accept:e.accept||Ar.Any}}const _r={Delete:"DELETE",Get:"GET",Post:"POST",Put:"PUT"};function Tr(e,t){return Promise.all(t.map((t=>e.get(t,(()=>Promise.resolve(Cr(t))))))).then((e=>{const r=e.filter((e=>function(e){return e.status===kr.Up||Date.now()-e.lastUpdate>xr}(e))),n=e.filter((e=>function(e){return e.status===kr.Timeouted&&Date.now()-e.lastUpdate<=xr}(e))),o=[...r,...n];return{getTimeout:(e,t)=>(0===n.length&&0===e?1:n.length+3+e)*t,statelessHosts:o.length>0?o.map((e=>Nr(e))):t}}))}const qr=(e,t)=>(e=>{const t=e.status;return e.isTimedOut||(({isTimedOut:e,status:t})=>!e&&!~~t)(e)||2!=~~(t/100)&&4!=~~(t/100)})(e)?t.onRetry(e):(({status:e})=>2==~~(e/100))(e)?t.onSuccess(e):t.onFail(e);function Rr(e,t,r,n){const o=[],i=function(e,t){if(e.method===_r.Get||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(r,n),a=function(e,t){const r={...e.headers,...t.headers},n={};return Object.keys(r).forEach((e=>{const t=r[e];n[e.toLowerCase()]=t})),n}(e,n),c=r.method,l=r.method!==_r.Get?{}:{...r.data,...n.data},u={"x-algolia-agent":e.userAgent.value,...e.queryParameters,...l,...n.queryParameters};let s=0;const f=(t,l)=>{const m=t.pop();if(void 0===m)throw{name:"RetryError",message:"Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support .",transporterStackTrace:Fr(o)};const p={data:i,headers:a,method:c,url:Mr(m,r.path,u),connectTimeout:l(s,e.timeouts.connect),responseTimeout:l(s,n.timeout)},v=e=>{const r={request:p,response:e,host:m,triesLeft:t.length};return o.push(r),r},d={onSuccess:e=>function(e){try{return JSON.parse(e.content)}catch(t){throw function(e,t){return{name:"DeserializationError",message:e,response:t}}(t.message,e)}}(e),onRetry(r){const n=v(r);return r.isTimedOut&&s++,Promise.all([e.logger.info("Retryable failure",Ur(n)),e.hostsCache.set(m,Cr(m,r.isTimedOut?kr.Timeouted:kr.Down))]).then((()=>f(t,l)))},onFail(e){throw v(e),function({content:e,status:t},r){let n=e;try{n=JSON.parse(e).message}catch(o){}return function(e,t,r){return{name:"ApiError",message:e,status:t,transporterStackTrace:r}}(n,t,r)}(e,Fr(o))}};return e.requester.send(p).then((e=>qr(e,d)))};return Tr(e.hostsCache,t).then((e=>f([...e.statelessHosts].reverse(),e.getTimeout)))}function Lr(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}function Mr(e,t,r){const n=Hr(r);let o=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return n.length&&(o+=`?${n}`),o}function Hr(e){return Object.keys(e).map((t=>{return Er("%s=%s",t,(r=e[t],"[object Object]"===Object.prototype.toString.call(r)||"[object Array]"===Object.prototype.toString.call(r)?JSON.stringify(e[t]):e[t]));var r})).join("&")}function Fr(e){return e.map((e=>Ur(e)))}function Ur(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}const Br=e=>{const t=e.appId,r=function(e,t,r){const n={"x-algolia-api-key":r,"x-algolia-application-id":t};return{headers:()=>e===Ir.WithinHeaders?n:{},queryParameters:()=>e===Ir.WithinQueryParameters?n:{}}}(void 0!==e.authMode?e.authMode:Ir.WithinHeaders,t,e.apiKey),n=function(e){const{hostsCache:t,logger:r,requester:n,requestsCache:o,responsesCache:i,timeouts:a,userAgent:c,hosts:l,queryParameters:u,headers:s}=e,f={hostsCache:t,logger:r,requester:n,requestsCache:o,responsesCache:i,timeouts:a,userAgent:c,headers:s,queryParameters:u,hosts:l.map((e=>Nr(e))),read(e,t){const r=Dr(t,f.timeouts.read),n=()=>Rr(f,f.hosts.filter((e=>!!(e.accept&Ar.Read))),e,r);if(!0!==(void 0!==r.cacheable?r.cacheable:e.cacheable))return n();const o={request:e,mappedRequestOptions:r,transporter:{queryParameters:f.queryParameters,headers:f.headers}};return f.responsesCache.get(o,(()=>f.requestsCache.get(o,(()=>f.requestsCache.set(o,n()).then((e=>Promise.all([f.requestsCache.delete(o),e])),(e=>Promise.all([f.requestsCache.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>f.responsesCache.set(o,e)})},write:(e,t)=>Rr(f,f.hosts.filter((e=>!!(e.accept&Ar.Write))),e,Dr(t,f.timeouts.write))};return f}({hosts:[{url:`${t}-dsn.algolia.net`,accept:Ar.Read},{url:`${t}.algolia.net`,accept:Ar.Write}].concat(jr([{url:`${t}-1.algolianet.com`},{url:`${t}-2.algolianet.com`},{url:`${t}-3.algolianet.com`}])),...e,headers:{...r.headers(),"content-type":"application/x-www-form-urlencoded",...e.headers},queryParameters:{...r.queryParameters(),...e.queryParameters}}),o={transporter:n,appId:t,addAlgoliaAgent(e,t){n.userAgent.add({segment:e,version:t})},clearCache:()=>Promise.all([n.requestsCache.clear(),n.responsesCache.clear()]).then((()=>{}))};return wr(o,e.methods)},Vr=e=>(t,r)=>t.method===_r.Get?e.transporter.read(t,r):e.transporter.write(t,r),Kr=e=>(t,r={})=>wr({transporter:e.transporter,appId:e.appId,indexName:t},r.methods),$r=e=>(t,r)=>{const n=t.map((e=>({...e,params:Hr(e.params||{})})));return e.transporter.read({method:_r.Post,path:"1/indexes/*/queries",data:{requests:n},cacheable:!0},r)},Jr=e=>(t,r)=>Promise.all(t.map((t=>{const{facetName:n,facetQuery:o,...i}=t.params;return Kr(e)(t.indexName,{methods:{searchForFacetValues:Qr}}).searchForFacetValues(n,o,{...r,...i})}))),zr=e=>(t,r,n)=>e.transporter.read({method:_r.Post,path:Er("1/answers/%s/prediction",e.indexName),data:{query:t,queryLanguages:r},cacheable:!0},n),Wr=e=>(t,r)=>e.transporter.read({method:_r.Post,path:Er("1/indexes/%s/query",e.indexName),data:{query:t},cacheable:!0},r),Qr=e=>(t,r,n)=>e.transporter.read({method:_r.Post,path:Er("1/indexes/%s/facets/%s/query",e.indexName,t),data:{facetQuery:r},cacheable:!0},n),Zr={Debug:1,Info:2,Error:3};const Gr=e=>(t,r)=>{const n=t.map((e=>({...e,threshold:e.threshold||0})));return e.transporter.read({method:_r.Post,path:"1/indexes/*/recommendations",data:{requests:n},cacheable:!0},r)};function Xr(e,t,r){const n={appId:e,apiKey:t,timeouts:{connect:1,read:2,write:30},requester:{send:e=>new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const n=(e,n)=>setTimeout((()=>{r.abort(),t({status:0,content:n,isTimedOut:!0})}),1e3*e),o=n(e.connectTimeout,"Connection timeout");let i;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===i&&(clearTimeout(o),i=n(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(o),clearTimeout(i),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(o),clearTimeout(i),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))},logger:(o=Zr.Error,{debug:(e,t)=>(Zr.Debug>=o&&console.debug(e,t),Promise.resolve()),info:(e,t)=>(Zr.Info>=o&&console.info(e,t),Promise.resolve()),error:(e,t)=>(console.error(e,t),Promise.resolve())}),responsesCache:Sr(),requestsCache:Sr({serializable:!1}),hostsCache:Or({caches:[gr({key:`${Pr}-${e}`}),Sr()]}),userAgent:Lr(Pr).add({segment:"Browser",version:"lite"}),authMode:Ir.WithinQueryParameters};var o;return Br({...n,...r,methods:{search:$r,searchForFacetValues:Jr,multipleQueries:$r,multipleSearchForFacetValues:Jr,customRequest:Vr,initIndex:e=>t=>Kr(e)(t,{methods:{search:Wr,searchForFacetValues:Qr,findAnswers:zr}}),getRecommendations:Gr}})}Xr.version=Pr;const Yr=Xr;var en="3.6.0";function tn(){}function rn(e){return e}function nn(e){return 1===e.button||e.altKey||e.ctrlKey||e.metaKey||e.shiftKey}function on(e,t,r){return e.reduce((function(e,n){var o=t(n);return e.hasOwnProperty(o)||(e[o]=[]),e[o].length<(r||5)&&e[o].push(n),e}),{})}var an=["footer","searchBox"];function cn(){return cn=Object.assign||function(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}function vn(e){var t=e.appId,r=e.apiKey,n=e.indexName,o=e.placeholder,i=void 0===o?"Search docs":o,a=e.searchParameters,c=e.maxResultsPerGroup,l=e.onClose,u=void 0===l?tn:l,s=e.transformItems,f=void 0===s?rn:s,m=e.hitComponent,p=void 0===m?St:m,v=e.resultsFooterComponent,d=void 0===v?function(){return null}:v,y=e.navigator,h=e.initialScrollY,b=void 0===h?0:h,g=e.transformSearchClient,O=void 0===g?rn:g,S=e.disableUserPersonalization,j=void 0!==S&&S,w=e.initialQuery,E=void 0===w?"":w,P=e.translations,I=void 0===P?{}:P,D=e.getMissingResultsUrl,A=e.insights,k=void 0!==A&&A,x=I.footer,C=I.searchBox,N=pn(I,an),_=fn(yt.useState({query:"",collections:[],completion:null,context:{},isOpen:!1,activeItemId:null,status:"idle"}),2),T=_[0],q=_[1],R=yt.useRef(null),L=yt.useRef(null),M=yt.useRef(null),H=yt.useRef(null),F=yt.useRef(null),U=yt.useRef(10),B=yt.useRef("undefined"!=typeof window?window.getSelection().toString().slice(0,ht):"").current,V=yt.useRef(E||B).current,K=function(e,t,r){return yt.useMemo((function(){var n=Yr(e,t);return n.addAlgoliaAgent("docsearch",en),!1===/docsearch.js \(.*\)/.test(n.transporter.userAgent.value)&&n.addAlgoliaAgent("docsearch-react",en),r(n)}),[e,t,r])}(t,r,O),$=yt.useRef(br({key:"__DOCSEARCH_FAVORITE_SEARCHES__".concat(n),limit:10})).current,J=yt.useRef(br({key:"__DOCSEARCH_RECENT_SEARCHES__".concat(n),limit:0===$.getAll().length?7:4})).current,z=yt.useCallback((function(e){if(!j){var t="content"===e.type?e.__docsearch_parent:e;t&&-1===$.getAll().findIndex((function(e){return e.objectID===t.objectID}))&&J.add(t)}}),[$,J,j]),W=yt.useCallback((function(e){if(T.context.algoliaInsightsPlugin&&e.__autocomplete_id){var t=e,r={eventName:"Item Selected",index:t.__autocomplete_indexName,items:[t],positions:[e.__autocomplete_id],queryID:t.__autocomplete_queryID};T.context.algoliaInsightsPlugin.insights.clickedObjectIDsAfterSearch(r)}}),[T.context.algoliaInsightsPlugin]),Q=yt.useMemo((function(){return dt({id:"docsearch",defaultActiveItemId:0,placeholder:i,openOnFocus:!0,initialState:{query:V,context:{searchSuggestions:[]}},insights:k,navigator:y,onStateChange:function(e){q(e.state)},getSources:function(e){var o=e.query,i=e.state,l=e.setContext,s=e.setStatus;if(!o)return j?[]:[{sourceId:"recentSearches",onSelect:function(e){var t=e.item,r=e.event;z(t),nn(r)||u()},getItemUrl:function(e){return e.item.url},getItems:function(){return J.getAll()}},{sourceId:"favoriteSearches",onSelect:function(e){var t=e.item,r=e.event;z(t),nn(r)||u()},getItemUrl:function(e){return e.item.url},getItems:function(){return $.getAll()}}];var m=Boolean(k);return K.search([{query:o,indexName:n,params:un({attributesToRetrieve:["hierarchy.lvl0","hierarchy.lvl1","hierarchy.lvl2","hierarchy.lvl3","hierarchy.lvl4","hierarchy.lvl5","hierarchy.lvl6","content","type","url"],attributesToSnippet:["hierarchy.lvl1:".concat(U.current),"hierarchy.lvl2:".concat(U.current),"hierarchy.lvl3:".concat(U.current),"hierarchy.lvl4:".concat(U.current),"hierarchy.lvl5:".concat(U.current),"hierarchy.lvl6:".concat(U.current),"content:".concat(U.current)],snippetEllipsisText:"\u2026",highlightPreTag:"",highlightPostTag:"",hitsPerPage:20,clickAnalytics:m},a)}]).catch((function(e){throw"RetryError"===e.name&&s("error"),e})).then((function(e){var o=e.results[0],a=o.hits,s=o.nbHits,p=on(a,(function(e){return Qt(e)}),c);i.context.searchSuggestions.length0&&(X(),F.current&&F.current.focus())}),[V,X]),yt.useEffect((function(){function e(){if(L.current){var e=.01*window.innerHeight;L.current.style.setProperty("--docsearch-vh","".concat(e,"px"))}}return e(),window.addEventListener("resize",e),function(){window.removeEventListener("resize",e)}}),[]),yt.createElement("div",cn({ref:R},G({"aria-expanded":!0}),{className:["DocSearch","DocSearch-Container","stalled"===T.status&&"DocSearch-Container--Stalled","error"===T.status&&"DocSearch-Container--Errored"].filter(Boolean).join(" "),role:"button",tabIndex:0,onMouseDown:function(e){e.target===e.currentTarget&&u()}}),yt.createElement("div",{className:"DocSearch-Modal",ref:L},yt.createElement("header",{className:"DocSearch-SearchBar",ref:M},yt.createElement(vr,cn({},Q,{state:T,autoFocus:0===V.length,inputRef:F,isFromSelection:Boolean(V)&&V===B,translations:C,onClose:u}))),yt.createElement("div",{className:"DocSearch-Dropdown",ref:H},yt.createElement(lr,cn({},Q,{indexName:n,state:T,hitComponent:p,resultsFooterComponent:d,disableUserPersonalization:j,recentSearches:J,favoriteSearches:$,inputRef:F,translations:N,getMissingResultsUrl:D,onItemClick:function(e,t){W(e),z(e),nn(t)||u()}}))),yt.createElement("footer",{className:"DocSearch-Footer"},yt.createElement(Ot,{translations:x}))))}}}]); \ No newline at end of file diff --git a/assets/js/95628813.3e39a569.js b/assets/js/95628813.3e39a569.js deleted file mode 100644 index 3a8b3e6686..0000000000 --- a/assets/js/95628813.3e39a569.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9153],{648:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=r(4848),t=r(8453);const o={},s="Enumeration: GroupNotificationTypes",c={id:"reference/api/model/group-metadata/enumerations/GroupNotificationTypes",title:"Enumeration: GroupNotificationTypes",description:"Group notification types",source:"@site/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",sourceDirName:"reference/api/model/group-metadata/enumerations",slug:"/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/group-metadata",permalink:"/docs/reference/api/model/group-metadata/"},next:{title:"Enumeration: groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ADD",id:"add",level:3},{value:"ANNOUNCE",id:"announce",level:3},{value:"DESCRIPTION",id:"description",level:3},{value:"INVITE",id:"invite",level:3},{value:"LEAVE",id:"leave",level:3},{value:"PICTURE",id:"picture",level:3},{value:"REMOVE",id:"remove",level:3},{value:"RESTRICT",id:"restrict",level:3},{value:"SUBJECT",id:"subject",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"enumeration-groupnotificationtypes",children:"Enumeration: GroupNotificationTypes"}),"\n",(0,i.jsx)(n.p,{children:"Group notification types"}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsx)(n.h3,{id:"add",children:"ADD"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ADD"}),": ",(0,i.jsx)(n.code,{children:'"add"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"announce",children:"ANNOUNCE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ANNOUNCE"}),": ",(0,i.jsx)(n.code,{children:'"announce"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"DESCRIPTION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DESCRIPTION"}),": ",(0,i.jsx)(n.code,{children:'"description"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"invite",children:"INVITE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"INVITE"}),": ",(0,i.jsx)(n.code,{children:'"invite"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"leave",children:"LEAVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LEAVE"}),": ",(0,i.jsx)(n.code,{children:'"leave"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"picture",children:"PICTURE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"PICTURE"}),": ",(0,i.jsx)(n.code,{children:'"picture"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remove",children:"REMOVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"REMOVE"}),": ",(0,i.jsx)(n.code,{children:'"remove"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restrict",children:"RESTRICT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RESTRICT"}),": ",(0,i.jsx)(n.code,{children:'"restrict"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"subject",children:"SUBJECT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SUBJECT"}),": ",(0,i.jsx)(n.code,{children:'"subject"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var i=r(6540);const t={},o=i.createContext(t);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95628813.855b7d85.js b/assets/js/95628813.855b7d85.js new file mode 100644 index 0000000000..18d93ae4fb --- /dev/null +++ b/assets/js/95628813.855b7d85.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9153],{648:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=r(4848),t=r(8453);const o={},s="Enumeration: GroupNotificationTypes",c={id:"reference/api/model/group-metadata/enumerations/GroupNotificationTypes",title:"Enumeration: GroupNotificationTypes",description:"Group notification types",source:"@site/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",sourceDirName:"reference/api/model/group-metadata/enumerations",slug:"/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",permalink:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/group-metadata",permalink:"/docs/reference/api/model/group-metadata/"},next:{title:"Enumeration: groupChangeEvent",permalink:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ADD",id:"add",level:3},{value:"ANNOUNCE",id:"announce",level:3},{value:"DESCRIPTION",id:"description",level:3},{value:"INVITE",id:"invite",level:3},{value:"LEAVE",id:"leave",level:3},{value:"PICTURE",id:"picture",level:3},{value:"REMOVE",id:"remove",level:3},{value:"RESTRICT",id:"restrict",level:3},{value:"SUBJECT",id:"subject",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"enumeration-groupnotificationtypes",children:"Enumeration: GroupNotificationTypes"})}),"\n",(0,i.jsx)(n.p,{children:"Group notification types"}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsx)(n.h3,{id:"add",children:"ADD"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ADD"}),": ",(0,i.jsx)(n.code,{children:'"add"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"announce",children:"ANNOUNCE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ANNOUNCE"}),": ",(0,i.jsx)(n.code,{children:'"announce"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"DESCRIPTION"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DESCRIPTION"}),": ",(0,i.jsx)(n.code,{children:'"description"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"invite",children:"INVITE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"INVITE"}),": ",(0,i.jsx)(n.code,{children:'"invite"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"leave",children:"LEAVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LEAVE"}),": ",(0,i.jsx)(n.code,{children:'"leave"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"picture",children:"PICTURE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"PICTURE"}),": ",(0,i.jsx)(n.code,{children:'"picture"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remove",children:"REMOVE"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"REMOVE"}),": ",(0,i.jsx)(n.code,{children:'"remove"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restrict",children:"RESTRICT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RESTRICT"}),": ",(0,i.jsx)(n.code,{children:'"restrict"'})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"subject",children:"SUBJECT"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SUBJECT"}),": ",(0,i.jsx)(n.code,{children:'"subject"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var i=r(6540);const t={},o=i.createContext(t);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98c048de.1ebb81dd.js b/assets/js/98c048de.1ebb81dd.js deleted file mode 100644 index 163f8fba27..0000000000 --- a/assets/js/98c048de.1ebb81dd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[488],{7190:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var o=r(4848),s=r(8453);const t={},c="Interface: SessionData",i={id:"reference/api/model/config/interfaces/SessionData",title:"Interface: SessionData",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/SessionData.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/SessionData.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials"},next:{title:"Interface: Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"WABrowserId?",id:"wabrowserid",level:3},{value:"WASecretBundle?",id:"wasecretbundle",level:3},{value:"WAToken1?",id:"watoken1",level:3},{value:"WAToken2?",id:"watoken2",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-sessiondata",children:"Interface: SessionData"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"wabrowserid",children:"WABrowserId?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WABrowserId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"wasecretbundle",children:"WASecretBundle?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WASecretBundle"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"watoken1",children:"WAToken1?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WAToken1"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"watoken2",children:"WAToken2?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WAToken2"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>i});var o=r(6540);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98c048de.acf0ff25.js b/assets/js/98c048de.acf0ff25.js new file mode 100644 index 0000000000..956a6a0677 --- /dev/null +++ b/assets/js/98c048de.acf0ff25.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[488],{7190:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var o=r(4848),s=r(8453);const t={},c="Interface: SessionData",i={id:"reference/api/model/config/interfaces/SessionData",title:"Interface: SessionData",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/SessionData.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/SessionData.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials"},next:{title:"Interface: Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"WABrowserId?",id:"wabrowserid",level:3},{value:"WASecretBundle?",id:"wasecretbundle",level:3},{value:"WAToken1?",id:"watoken1",level:3},{value:"WAToken2?",id:"watoken2",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"interface-sessiondata",children:"Interface: SessionData"})}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"wabrowserid",children:"WABrowserId?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WABrowserId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"wasecretbundle",children:"WASecretBundle?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WASecretBundle"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"watoken1",children:"WAToken1?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WAToken1"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"watoken2",children:"WAToken2?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"WAToken2"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>i});var o=r(6540);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a514765.557cdb64.js b/assets/js/9a514765.557cdb64.js new file mode 100644 index 0000000000..26a1a0c3a0 --- /dev/null +++ b/assets/js/9a514765.557cdb64.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9099],{6873:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const o={},a="Enumeration: ChatTypes",c={id:"reference/api/model/chat/enumerations/ChatTypes",title:"Enumeration: ChatTypes",description:"Chat types",source:"@site/docs/reference/api/model/chat/enumerations/ChatTypes.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState"},next:{title:"Interface: BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat"}},i={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"GROUP",id:"group",level:3},{value:"SOLO",id:"solo",level:3},{value:"UNKNOWN",id:"unknown",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-chattypes",children:"Enumeration: ChatTypes"})}),"\n",(0,r.jsx)(n.p,{children:"Chat types"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"group",children:"GROUP"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP"}),": ",(0,r.jsx)(n.code,{children:'"group"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"solo",children:"SOLO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"SOLO"}),": ",(0,r.jsx)(n.code,{children:'"solo"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unknown",children:"UNKNOWN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNKNOWN"}),": ",(0,r.jsx)(n.code,{children:'"unknown"'})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var r=t(6540);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a514765.f4bef24f.js b/assets/js/9a514765.f4bef24f.js deleted file mode 100644 index d652a455d5..0000000000 --- a/assets/js/9a514765.f4bef24f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9099],{6873:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const o={},a="Enumeration: ChatTypes",c={id:"reference/api/model/chat/enumerations/ChatTypes",title:"Enumeration: ChatTypes",description:"Chat types",source:"@site/docs/reference/api/model/chat/enumerations/ChatTypes.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatTypes",permalink:"/docs/reference/api/model/chat/enumerations/ChatTypes",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatTypes.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState"},next:{title:"Interface: BaseChat",permalink:"/docs/reference/api/model/chat/interfaces/BaseChat"}},i={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"GROUP",id:"group",level:3},{value:"SOLO",id:"solo",level:3},{value:"UNKNOWN",id:"unknown",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-chattypes",children:"Enumeration: ChatTypes"}),"\n",(0,r.jsx)(n.p,{children:"Chat types"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"group",children:"GROUP"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP"}),": ",(0,r.jsx)(n.code,{children:'"group"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"solo",children:"SOLO"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"SOLO"}),": ",(0,r.jsx)(n.code,{children:'"solo"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unknown",children:"UNKNOWN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"UNKNOWN"}),": ",(0,r.jsx)(n.code,{children:'"unknown"'})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var r=t(6540);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9aa93c82.0bff8758.js b/assets/js/9aa93c82.0bff8758.js new file mode 100644 index 0000000000..79fa1dc573 --- /dev/null +++ b/assets/js/9aa93c82.0bff8758.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3703],{865:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>l});var r=n(4848),a=n(8453);const s={},t="api/model/media",d={id:"reference/api/model/media/index",title:"api/model/media",description:"Index",source:"@site/docs/reference/api/model/media/index.md",sourceDirName:"reference/api/model/media",slug:"/reference/api/model/media/",permalink:"/docs/reference/api/model/media/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Label",permalink:"/docs/reference/api/model/label/interfaces/Label"},next:{title:"Type Alias: Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions"}},o={},l=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3}];function c(e){const i={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"apimodelmedia",children:"api/model/media"})}),"\n",(0,r.jsx)(i.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(i.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})}),"\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})}),"\n"]}),"\n",(0,r.jsx)(i.h3,{id:"variables",children:"Variables"}),"\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:(0,r.jsx)(i.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})}),"\n"]})]})}function p(e={}){const{wrapper:i}={...(0,a.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>t,x:()=>d});var r=n(6540);const a={},s=r.createContext(a);function t(e){const i=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),r.createElement(s.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9aa93c82.63669659.js b/assets/js/9aa93c82.63669659.js deleted file mode 100644 index 468e61ccb4..0000000000 --- a/assets/js/9aa93c82.63669659.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3703],{865:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var s=n(4848),r=n(8453);const a={},t="api/model/media",d={id:"reference/api/model/media/index",title:"api/model/media",description:"Index",source:"@site/docs/reference/api/model/media/index.md",sourceDirName:"reference/api/model/media",slug:"/reference/api/model/media/",permalink:"/docs/reference/api/model/media/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Label",permalink:"/docs/reference/api/model/label/interfaces/Label"},next:{title:"Type Alias: Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions"}},o={},l=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3}];function c(e){const i={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"apimodelmedia",children:"api/model/media"}),"\n",(0,s.jsx)(i.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(i.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:(0,s.jsx)(i.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})}),"\n",(0,s.jsx)(i.li,{children:(0,s.jsx)(i.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})}),"\n"]}),"\n",(0,s.jsx)(i.h3,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:(0,s.jsx)(i.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})}),"\n"]})]})}function p(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>t,x:()=>d});var s=n(6540);const r={},a=s.createContext(r);function t(e){const i=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(a.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ab3d06b.3d844e61.js b/assets/js/9ab3d06b.3d844e61.js deleted file mode 100644 index e7e18f1a05..0000000000 --- a/assets/js/9ab3d06b.3d844e61.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3128],{7986:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>E,frontMatter:()=>i,metadata:()=>t,toc:()=>o});var r=s(4848),c=s(8453);const i={},d="Enumeration: Events",t={id:"reference/api/model/enumerations/Events",title:"Enumeration: Events",description:"Events that can be emitted by the client",source:"@site/docs/reference/api/model/enumerations/Events.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/Events",permalink:"/docs/reference/api/model/enumerations/Events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/Events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck"},next:{title:"Enumeration: STATE",permalink:"/docs/reference/api/model/enumerations/STATE"}},l={},o=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTHENTICATED",id:"authenticated",level:3},{value:"AUTHENTICATION_FAILURE",id:"authentication_failure",level:3},{value:"DISCONNECTED",id:"disconnected",level:3},{value:"GROUP_JOIN",id:"group_join",level:3},{value:"GROUP_LEAVE",id:"group_leave",level:3},{value:"GROUP_UPDATE",id:"group_update",level:3},{value:"MESSAGE_ACK",id:"message_ack",level:3},{value:"MESSAGE_CREATE",id:"message_create",level:3},{value:"MESSAGE_RECEIVED",id:"message_received",level:3},{value:"MESSAGE_REVOKED_EVERYONE",id:"message_revoked_everyone",level:3},{value:"MESSAGE_REVOKED_ME",id:"message_revoked_me",level:3},{value:"QR_RECEIVED",id:"qr_received",level:3},{value:"READY",id:"ready",level:3},{value:"STATE_CHANGED",id:"state_changed",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-events",children:"Enumeration: Events"}),"\n",(0,r.jsx)(n.p,{children:"Events that can be emitted by the client"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"authenticated",children:"AUTHENTICATED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATED"}),": ",(0,r.jsx)(n.code,{children:'"authenticated"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"authentication_failure",children:"AUTHENTICATION_FAILURE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATION_FAILURE"}),": ",(0,r.jsx)(n.code,{children:'"auth_failure"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disconnected",children:"DISCONNECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DISCONNECTED"}),": ",(0,r.jsx)(n.code,{children:'"disconnected"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_join",children:"GROUP_JOIN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_JOIN"}),": ",(0,r.jsx)(n.code,{children:'"group_join"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_leave",children:"GROUP_LEAVE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_LEAVE"}),": ",(0,r.jsx)(n.code,{children:'"group_leave"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_update",children:"GROUP_UPDATE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_UPDATE"}),": ",(0,r.jsx)(n.code,{children:'"group_update"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_ack",children:"MESSAGE_ACK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_ACK"}),": ",(0,r.jsx)(n.code,{children:'"message_ack"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_create",children:"MESSAGE_CREATE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_CREATE"}),": ",(0,r.jsx)(n.code,{children:'"message_create"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_received",children:"MESSAGE_RECEIVED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_RECEIVED"}),": ",(0,r.jsx)(n.code,{children:'"message"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_revoked_everyone",children:"MESSAGE_REVOKED_EVERYONE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_REVOKED_EVERYONE"}),": ",(0,r.jsx)(n.code,{children:'"message_revoke_everyone"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_revoked_me",children:"MESSAGE_REVOKED_ME"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_REVOKED_ME"}),": ",(0,r.jsx)(n.code,{children:'"message_revoke_me"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"qr_received",children:"QR_RECEIVED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"QR_RECEIVED"}),": ",(0,r.jsx)(n.code,{children:'"qr"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ready",children:"READY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"READY"}),": ",(0,r.jsx)(n.code,{children:'"ready"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"state_changed",children:"STATE_CHANGED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"STATE_CHANGED"}),": ",(0,r.jsx)(n.code,{children:'"change_state"'})]}),"\n"]})]})}function E(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>t});var r=s(6540);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ab3d06b.7123835a.js b/assets/js/9ab3d06b.7123835a.js new file mode 100644 index 0000000000..911a2db2df --- /dev/null +++ b/assets/js/9ab3d06b.7123835a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3128],{7986:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>a,frontMatter:()=>i,metadata:()=>t,toc:()=>o});var r=s(4848),c=s(8453);const i={},d="Enumeration: Events",t={id:"reference/api/model/enumerations/Events",title:"Enumeration: Events",description:"Events that can be emitted by the client",source:"@site/docs/reference/api/model/enumerations/Events.md",sourceDirName:"reference/api/model/enumerations",slug:"/reference/api/model/enumerations/Events",permalink:"/docs/reference/api/model/enumerations/Events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/enumerations/Events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: NumberCheck",permalink:"/docs/reference/api/model/contact/interfaces/NumberCheck"},next:{title:"Enumeration: STATE",permalink:"/docs/reference/api/model/enumerations/STATE"}},l={},o=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTHENTICATED",id:"authenticated",level:3},{value:"AUTHENTICATION_FAILURE",id:"authentication_failure",level:3},{value:"DISCONNECTED",id:"disconnected",level:3},{value:"GROUP_JOIN",id:"group_join",level:3},{value:"GROUP_LEAVE",id:"group_leave",level:3},{value:"GROUP_UPDATE",id:"group_update",level:3},{value:"MESSAGE_ACK",id:"message_ack",level:3},{value:"MESSAGE_CREATE",id:"message_create",level:3},{value:"MESSAGE_RECEIVED",id:"message_received",level:3},{value:"MESSAGE_REVOKED_EVERYONE",id:"message_revoked_everyone",level:3},{value:"MESSAGE_REVOKED_ME",id:"message_revoked_me",level:3},{value:"QR_RECEIVED",id:"qr_received",level:3},{value:"READY",id:"ready",level:3},{value:"STATE_CHANGED",id:"state_changed",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-events",children:"Enumeration: Events"})}),"\n",(0,r.jsx)(n.p,{children:"Events that can be emitted by the client"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"authenticated",children:"AUTHENTICATED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATED"}),": ",(0,r.jsx)(n.code,{children:'"authenticated"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"authentication_failure",children:"AUTHENTICATION_FAILURE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"AUTHENTICATION_FAILURE"}),": ",(0,r.jsx)(n.code,{children:'"auth_failure"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disconnected",children:"DISCONNECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DISCONNECTED"}),": ",(0,r.jsx)(n.code,{children:'"disconnected"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_join",children:"GROUP_JOIN"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_JOIN"}),": ",(0,r.jsx)(n.code,{children:'"group_join"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_leave",children:"GROUP_LEAVE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_LEAVE"}),": ",(0,r.jsx)(n.code,{children:'"group_leave"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"group_update",children:"GROUP_UPDATE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"GROUP_UPDATE"}),": ",(0,r.jsx)(n.code,{children:'"group_update"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_ack",children:"MESSAGE_ACK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_ACK"}),": ",(0,r.jsx)(n.code,{children:'"message_ack"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_create",children:"MESSAGE_CREATE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_CREATE"}),": ",(0,r.jsx)(n.code,{children:'"message_create"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_received",children:"MESSAGE_RECEIVED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_RECEIVED"}),": ",(0,r.jsx)(n.code,{children:'"message"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_revoked_everyone",children:"MESSAGE_REVOKED_EVERYONE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_REVOKED_EVERYONE"}),": ",(0,r.jsx)(n.code,{children:'"message_revoke_everyone"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message_revoked_me",children:"MESSAGE_REVOKED_ME"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MESSAGE_REVOKED_ME"}),": ",(0,r.jsx)(n.code,{children:'"message_revoke_me"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"qr_received",children:"QR_RECEIVED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"QR_RECEIVED"}),": ",(0,r.jsx)(n.code,{children:'"qr"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ready",children:"READY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"READY"}),": ",(0,r.jsx)(n.code,{children:'"ready"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"state_changed",children:"STATE_CHANGED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"STATE_CHANGED"}),": ",(0,r.jsx)(n.code,{children:'"change_state"'})]}),"\n"]})]})}function a(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>t});var r=s(6540);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9bd6a0c8.46c7e544.js b/assets/js/9bd6a0c8.46c7e544.js new file mode 100644 index 0000000000..71e9e2fc0b --- /dev/null +++ b/assets/js/9bd6a0c8.46c7e544.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3354],{5315:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(4848),s=n(8453);const i={},o="Interface: DialogProperty",c={id:"reference/structures/Dialog/interfaces/DialogProperty",title:"Interface: DialogProperty",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogProperty.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogProperty.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection"},next:{title:"Interface: DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"options?",id:"options",level:3},{value:"order",id:"order",level:3},{value:"prompt",id:"prompt",level:3},{value:"skipCondition?",id:"skipcondition",level:3},{value:"type",id:"type",level:3},{value:"validation",id:"validation",level:3}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"interface-dialogproperty",children:"Interface: DialogProperty"})}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"key",children:"key"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"key"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"options",children:"options?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"options"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogButtons",children:(0,t.jsx)(r.code,{children:"DialogButtons"})}),"[] | ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",children:(0,t.jsx)(r.code,{children:"DialogListMessageSection"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"order",children:"order"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"order"}),": ",(0,t.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"prompt",children:"prompt"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"prompt"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"skipcondition",children:"skipCondition?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"skipCondition"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:(0,t.jsx)(r.code,{children:"CheckFunction"})})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"type"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"validation",children:"validation"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"validation"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogValidation",children:(0,t.jsx)(r.code,{children:"DialogValidation"})}),"[]"]}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>c});var t=n(6540);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9bd6a0c8.78e7ef1f.js b/assets/js/9bd6a0c8.78e7ef1f.js deleted file mode 100644 index d6f1b0e739..0000000000 --- a/assets/js/9bd6a0c8.78e7ef1f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3354],{5315:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(4848),s=n(8453);const i={},o="Interface: DialogProperty",c={id:"reference/structures/Dialog/interfaces/DialogProperty",title:"Interface: DialogProperty",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogProperty.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogProperty.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogListMessageSection",permalink:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection"},next:{title:"Interface: DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"options?",id:"options",level:3},{value:"order",id:"order",level:3},{value:"prompt",id:"prompt",level:3},{value:"skipCondition?",id:"skipcondition",level:3},{value:"type",id:"type",level:3},{value:"validation",id:"validation",level:3}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-dialogproperty",children:"Interface: DialogProperty"}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"key",children:"key"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"key"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"options",children:"options?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"options"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogButtons",children:(0,t.jsx)(r.code,{children:"DialogButtons"})}),"[] | ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",children:(0,t.jsx)(r.code,{children:"DialogListMessageSection"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"order",children:"order"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"order"}),": ",(0,t.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"prompt",children:"prompt"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"prompt"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"skipcondition",children:"skipCondition?"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"optional"})," ",(0,t.jsx)(r.strong,{children:"skipCondition"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:(0,t.jsx)(r.code,{children:"CheckFunction"})})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"type"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"validation",children:"validation"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"validation"}),": ",(0,t.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogValidation",children:(0,t.jsx)(r.code,{children:"DialogValidation"})}),"[]"]}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>c});var t=n(6540);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d5f1ccb.8fc0cc25.js b/assets/js/9d5f1ccb.8fc0cc25.js new file mode 100644 index 0000000000..49ff173fd9 --- /dev/null +++ b/assets/js/9d5f1ccb.8fc0cc25.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2910],{1203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var r=t(4848),o=t(8453);const i={},c="api/model/button",d={id:"reference/api/model/button/index",title:"api/model/button",description:"Index",source:"@site/docs/reference/api/model/button/index.md",sourceDirName:"reference/api/model/button",slug:"/reference/api/model/button/",permalink:"/docs/reference/api/model/button/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers"},next:{title:"Interface: AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton"}},a={},s=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelbutton",children:"api/model/button"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:"AdvancedButton"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:"Button"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:"LocationButtonBody"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:"Row"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:"Section"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>d});var r=t(6540);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d5f1ccb.f0f3babe.js b/assets/js/9d5f1ccb.f0f3babe.js deleted file mode 100644 index 3d7a34b3cc..0000000000 --- a/assets/js/9d5f1ccb.f0f3babe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2910],{1203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>a});var r=t(4848),o=t(8453);const i={},c="api/model/button",s={id:"reference/api/model/button/index",title:"api/model/button",description:"Index",source:"@site/docs/reference/api/model/button/index.md",sourceDirName:"reference/api/model/button",slug:"/reference/api/model/button/",permalink:"/docs/reference/api/model/button/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers"},next:{title:"Interface: AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton"}},d={},a=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodelbutton",children:"api/model/button"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:"AdvancedButton"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:"Button"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:"LocationButtonBody"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:"Row"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:"Section"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var r=t(6540);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9e4087bc.241c03dd.js b/assets/js/9e4087bc.16fcacde.js similarity index 96% rename from assets/js/9e4087bc.241c03dd.js rename to assets/js/9e4087bc.16fcacde.js index ce99dbec78..1ae446b84b 100644 --- a/assets/js/9e4087bc.241c03dd.js +++ b/assets/js/9e4087bc.16fcacde.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2711],{9331:(e,r,t)=>{t.r(r),t.d(r,{default:()=>m});t(6540);var a=t(8774),n=t(1312),s=t(5500),i=t(6266),c=t(9201),l=t(1107),o=t(4848);function d(e){let{year:r,posts:t}=e;const n=(0,i.i)({day:"numeric",month:"long",timeZone:"UTC"});return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(l.A,{as:"h3",id:r,children:r}),(0,o.jsx)("ul",{children:t.map((e=>{return(0,o.jsx)("li",{children:(0,o.jsxs)(a.A,{to:e.metadata.permalink,children:[(r=e.metadata.date,n.format(new Date(r)))," - ",e.metadata.title]})},e.metadata.date);var r}))})]})}function h(e){let{years:r}=e;return(0,o.jsx)("section",{className:"margin-vert--lg",children:(0,o.jsx)("div",{className:"container",children:(0,o.jsx)("div",{className:"row",children:r.map(((e,r)=>(0,o.jsx)("div",{className:"col col--4 margin-vert--lg",children:(0,o.jsx)(d,{...e})},r)))})})})}function m(e){let{archive:r}=e;const t=(0,n.T)({id:"theme.blog.archive.title",message:"Archive",description:"The page & hero title of the blog archive page"}),a=(0,n.T)({id:"theme.blog.archive.description",message:"Archive",description:"The page & hero description of the blog archive page"}),i=function(e){const r=e.reduce(((e,r)=>{const t=r.metadata.date.split("-")[0],a=e.get(t)??[];return e.set(t,[r,...a])}),new Map);return Array.from(r,(e=>{let[r,t]=e;return{year:r,posts:t}}))}(r.blogPosts);return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.be,{title:t,description:a}),(0,o.jsxs)(c.A,{children:[(0,o.jsx)("header",{className:"hero hero--primary",children:(0,o.jsxs)("div",{className:"container",children:[(0,o.jsx)(l.A,{as:"h1",className:"hero__title",children:t}),(0,o.jsx)("p",{className:"hero__subtitle",children:a})]})}),(0,o.jsx)("main",{children:i.length>0&&(0,o.jsx)(h,{years:i})})]})]})}},6266:(e,r,t)=>{t.d(r,{i:()=>n});var a=t(4586);function n(e){void 0===e&&(e={});const{i18n:{currentLocale:r}}=(0,a.A)(),t=function(){const{i18n:{currentLocale:e,localeConfigs:r}}=(0,a.A)();return r[e].calendar}();return new Intl.DateTimeFormat(r,{calendar:t,...e})}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2711],{9331:(e,r,t)=>{t.r(r),t.d(r,{default:()=>m});t(6540);var a=t(8774),n=t(1312),s=t(5500),i=t(6266),c=t(3277),l=t(1107),o=t(4848);function d(e){let{year:r,posts:t}=e;const n=(0,i.i)({day:"numeric",month:"long",timeZone:"UTC"});return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(l.A,{as:"h3",id:r,children:r}),(0,o.jsx)("ul",{children:t.map((e=>{return(0,o.jsx)("li",{children:(0,o.jsxs)(a.A,{to:e.metadata.permalink,children:[(r=e.metadata.date,n.format(new Date(r)))," - ",e.metadata.title]})},e.metadata.date);var r}))})]})}function h(e){let{years:r}=e;return(0,o.jsx)("section",{className:"margin-vert--lg",children:(0,o.jsx)("div",{className:"container",children:(0,o.jsx)("div",{className:"row",children:r.map(((e,r)=>(0,o.jsx)("div",{className:"col col--4 margin-vert--lg",children:(0,o.jsx)(d,{...e})},r)))})})})}function m(e){let{archive:r}=e;const t=(0,n.T)({id:"theme.blog.archive.title",message:"Archive",description:"The page & hero title of the blog archive page"}),a=(0,n.T)({id:"theme.blog.archive.description",message:"Archive",description:"The page & hero description of the blog archive page"}),i=function(e){const r=e.reduce(((e,r)=>{const t=r.metadata.date.split("-")[0],a=e.get(t)??[];return e.set(t,[r,...a])}),new Map);return Array.from(r,(e=>{let[r,t]=e;return{year:r,posts:t}}))}(r.blogPosts);return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.be,{title:t,description:a}),(0,o.jsxs)(c.A,{children:[(0,o.jsx)("header",{className:"hero hero--primary",children:(0,o.jsxs)("div",{className:"container",children:[(0,o.jsx)(l.A,{as:"h1",className:"hero__title",children:t}),(0,o.jsx)("p",{className:"hero__subtitle",children:a})]})}),(0,o.jsx)("main",{children:i.length>0&&(0,o.jsx)(h,{years:i})})]})]})}},6266:(e,r,t)=>{t.d(r,{i:()=>n});var a=t(4586);function n(e){void 0===e&&(e={});const{i18n:{currentLocale:r}}=(0,a.A)(),t=function(){const{i18n:{currentLocale:e,localeConfigs:r}}=(0,a.A)();return r[e].calendar}();return new Intl.DateTimeFormat(r,{calendar:t,...e})}}}]); \ No newline at end of file diff --git a/assets/js/a08b55b4.3fe2cd3e.js b/assets/js/a08b55b4.3fe2cd3e.js deleted file mode 100644 index 8e43e35455..0000000000 --- a/assets/js/a08b55b4.3fe2cd3e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7746],{7331:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>c});var a=s(4848),t=s(8453);const n={},o="Type Alias: WaServers",i={id:"reference/api/model/aliases/type-aliases/WaServers",title:"Type Alias: WaServers",description:"WaServers: ChatServer \\| GroupChatServer",source:"@site/docs/reference/api/model/aliases/type-aliases/WaServers.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/WaServers.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId"},next:{title:"api/model/button",permalink:"/docs/reference/api/model/button/"}},l={},c=[];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.h1,{id:"type-alias-waservers",children:"Type Alias: WaServers"}),"\n",(0,a.jsxs)(r.blockquote,{children:["\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.strong,{children:"WaServers"}),": ",(0,a.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:(0,a.jsx)(r.code,{children:"ChatServer"})})," | ",(0,a.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:(0,a.jsx)(r.code,{children:"GroupChatServer"})})]}),"\n"]}),"\n",(0,a.jsx)(r.p,{children:'A type alias for all available "servers"'})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>i});var a=s(6540);const t={},n=a.createContext(t);function o(e){const r=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),a.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a08b55b4.5d84fe8c.js b/assets/js/a08b55b4.5d84fe8c.js new file mode 100644 index 0000000000..813fe71ba9 --- /dev/null +++ b/assets/js/a08b55b4.5d84fe8c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7746],{7331:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>c});var a=s(4848),t=s(8453);const n={},o="Type Alias: WaServers",i={id:"reference/api/model/aliases/type-aliases/WaServers",title:"Type Alias: WaServers",description:"WaServers: ChatServer \\| GroupChatServer",source:"@site/docs/reference/api/model/aliases/type-aliases/WaServers.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/WaServers.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId"},next:{title:"api/model/button",permalink:"/docs/reference/api/model/button/"}},l={},c=[];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.header,{children:(0,a.jsx)(r.h1,{id:"type-alias-waservers",children:"Type Alias: WaServers"})}),"\n",(0,a.jsxs)(r.blockquote,{children:["\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.strong,{children:"WaServers"}),": ",(0,a.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:(0,a.jsx)(r.code,{children:"ChatServer"})})," | ",(0,a.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:(0,a.jsx)(r.code,{children:"GroupChatServer"})})]}),"\n"]}),"\n",(0,a.jsx)(r.p,{children:'A type alias for all available "servers"'})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>i});var a=s(6540);const t={},n=a.createContext(t);function o(e){const r=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),a.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a0ef4106.400a505a.js b/assets/js/a0ef4106.400a505a.js deleted file mode 100644 index 0a5cb02737..0000000000 --- a/assets/js/a0ef4106.400a505a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2534],{6280:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=s(4848),r=s(8453);const o={},t="Type Alias: Mp4StickerConversionProcessOptions",l={id:"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",title:"Type Alias: Mp4StickerConversionProcessOptions",description:"Mp4StickerConversionProcessOptions: object",source:"@site/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",sourceDirName:"reference/api/model/media/type-aliases",slug:"/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/media",permalink:"/docs/reference/api/model/media/"},next:{title:"Type Alias: StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata"}},c={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"crop?",id:"crop",level:3},{value:"endTime?",id:"endtime",level:3},{value:"Default",id:"default",level:4},{value:"fps?",id:"fps",level:3},{value:"Default",id:"default-1",level:4},{value:"log?",id:"log",level:3},{value:"Default",id:"default-2",level:4},{value:"loop?",id:"loop",level:3},{value:"square?",id:"square",level:3},{value:"startTime?",id:"starttime",level:3},{value:"Default",id:"default-3",level:4}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"type-alias-mp4stickerconversionprocessoptions",children:"Type Alias: Mp4StickerConversionProcessOptions"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mp4StickerConversionProcessOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsx)(n.h3,{id:"crop",children:"crop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"crop"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Centres and crops the video.\ndefault ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h3,{id:"endtime",children:"endTime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"endTime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The video end time of the sticker. By default, stickers are made from the first 5 seconds of the video"}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"00:00:05.0"})}),"\n",(0,i.jsx)(n.h3,{id:"fps",children:"fps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"fps"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Desired Frames per second of the sticker output"}),"\n",(0,i.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"10"})}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"log"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Prints ffmpeg logs in the terminal"}),"\n",(0,i.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.h3,{id:"loop",children:"loop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"loop"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The amount of times the video loops in the sticker. To save processing time, leave this as 0\ndefault ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.h3,{id:"square",children:"square?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"square"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A number representing the WxH of the output sticker (default ",(0,i.jsx)(n.code,{children:"512x512"}),"). Lowering this number is a great way to process longer duration stickers. The max value is ",(0,i.jsx)(n.code,{children:"512"}),".\ndefault ",(0,i.jsx)(n.code,{children:"512"})]}),"\n",(0,i.jsx)(n.h3,{id:"starttime",children:"startTime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"startTime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The video start time of the sticker"}),"\n",(0,i.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"00:00:00.0"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(6540);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a0ef4106.5522adde.js b/assets/js/a0ef4106.5522adde.js new file mode 100644 index 0000000000..a7affd8352 --- /dev/null +++ b/assets/js/a0ef4106.5522adde.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2534],{6280:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=s(4848),r=s(8453);const o={},t="Type Alias: Mp4StickerConversionProcessOptions",l={id:"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",title:"Type Alias: Mp4StickerConversionProcessOptions",description:"Mp4StickerConversionProcessOptions: object",source:"@site/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",sourceDirName:"reference/api/model/media/type-aliases",slug:"/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",permalink:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/media",permalink:"/docs/reference/api/model/media/"},next:{title:"Type Alias: StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata"}},c={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"crop?",id:"crop",level:3},{value:"endTime?",id:"endtime",level:3},{value:"Default",id:"default",level:4},{value:"fps?",id:"fps",level:3},{value:"Default",id:"default-1",level:4},{value:"log?",id:"log",level:3},{value:"Default",id:"default-2",level:4},{value:"loop?",id:"loop",level:3},{value:"square?",id:"square",level:3},{value:"startTime?",id:"starttime",level:3},{value:"Default",id:"default-3",level:4}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"type-alias-mp4stickerconversionprocessoptions",children:"Type Alias: Mp4StickerConversionProcessOptions"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mp4StickerConversionProcessOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsx)(n.h3,{id:"crop",children:"crop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"crop"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Centres and crops the video.\ndefault ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.h3,{id:"endtime",children:"endTime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"endTime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The video end time of the sticker. By default, stickers are made from the first 5 seconds of the video"}),"\n",(0,i.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"00:00:05.0"})}),"\n",(0,i.jsx)(n.h3,{id:"fps",children:"fps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"fps"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Desired Frames per second of the sticker output"}),"\n",(0,i.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"10"})}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"log"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Prints ffmpeg logs in the terminal"}),"\n",(0,i.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"false"})}),"\n",(0,i.jsx)(n.h3,{id:"loop",children:"loop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"loop"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The amount of times the video loops in the sticker. To save processing time, leave this as 0\ndefault ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.h3,{id:"square",children:"square?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"square"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A number representing the WxH of the output sticker (default ",(0,i.jsx)(n.code,{children:"512x512"}),"). Lowering this number is a great way to process longer duration stickers. The max value is ",(0,i.jsx)(n.code,{children:"512"}),".\ndefault ",(0,i.jsx)(n.code,{children:"512"})]}),"\n",(0,i.jsx)(n.h3,{id:"starttime",children:"startTime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"startTime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The video start time of the sticker"}),"\n",(0,i.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"00:00:00.0"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(6540);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3711c17.86c861ad.js b/assets/js/a3711c17.a78d151a.js similarity index 52% rename from assets/js/a3711c17.86c861ad.js rename to assets/js/a3711c17.a78d151a.js index cd6c15787d..c5b087c130 100644 --- a/assets/js/a3711c17.86c861ad.js +++ b/assets/js/a3711c17.a78d151a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5235],{3544:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var n=o(4848),s=o(8453);const r={},i="SendFile",c={id:"how-to/sendfile",title:"SendFile",description:"",source:"@site/docs/how-to/sendfile.md",sourceDirName:"how-to",slug:"/how-to/sendfile",permalink:"/docs/how-to/sendfile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/sendfile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Send Video",permalink:"/docs/how-to/send-videos"},next:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"}},d={},a=[];function u(e){const t={h1:"h1",...(0,s.R)(),...e.components};return(0,n.jsx)(t.h1,{id:"sendfile",children:"SendFile"})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>i,x:()=>c});var n=o(6540);const s={},r=n.createContext(s);function i(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5235],{3544:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var n=o(4848),s=o(8453);const r={},i="SendFile",c={id:"how-to/sendfile",title:"SendFile",description:"",source:"@site/docs/how-to/sendfile.md",sourceDirName:"how-to",slug:"/how-to/sendfile",permalink:"/docs/how-to/sendfile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/sendfile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Send Video",permalink:"/docs/how-to/send-videos"},next:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"}},d={},a=[];function u(e){const t={h1:"h1",header:"header",...(0,s.R)(),...e.components};return(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"sendfile",children:"SendFile"})})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>i,x:()=>c});var n=o(6540);const s={},r=n.createContext(s);function i(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a485a49d.0a34157a.js b/assets/js/a485a49d.0a34157a.js deleted file mode 100644 index b0de25dde3..0000000000 --- a/assets/js/a485a49d.0a34157a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1237],{4449:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var n=t(4848),s=t(8453);const i={},o="Interface: DialogValidation",c={id:"reference/structures/Dialog/interfaces/DialogValidation",title:"Interface: DialogValidation",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogValidation.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogValidation.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate"},next:{title:"Type Alias: CheckFunction()",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"errorMessage",id:"errormessage",level:3},{value:"type",id:"type",level:3},{value:"value",id:"value",level:3}];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-dialogvalidation",children:"Interface: DialogValidation"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"errormessage",children:"errorMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"errorMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"type",children:"type"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"type"}),": ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/enumerations/ValidationType",children:(0,n.jsx)(r.code,{children:"ValidationType"})})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"value",children:"value"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"string"})," | ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:(0,n.jsx)(r.code,{children:"CheckFunction"})})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>c});var n=t(6540);const s={},i=n.createContext(s);function o(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a485a49d.9ecb4ad7.js b/assets/js/a485a49d.9ecb4ad7.js new file mode 100644 index 0000000000..23de363c24 --- /dev/null +++ b/assets/js/a485a49d.9ecb4ad7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1237],{4449:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var n=t(4848),s=t(8453);const i={},o="Interface: DialogValidation",a={id:"reference/structures/Dialog/interfaces/DialogValidation",title:"Interface: DialogValidation",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogValidation.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogValidation",permalink:"/docs/reference/structures/Dialog/interfaces/DialogValidation",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogValidation.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate"},next:{title:"Type Alias: CheckFunction()",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"errorMessage",id:"errormessage",level:3},{value:"type",id:"type",level:3},{value:"value",id:"value",level:3}];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-dialogvalidation",children:"Interface: DialogValidation"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"errormessage",children:"errorMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"errorMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"type",children:"type"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"type"}),": ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/enumerations/ValidationType",children:(0,n.jsx)(r.code,{children:"ValidationType"})})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"value",children:"value"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"string"})," | ",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:(0,n.jsx)(r.code,{children:"CheckFunction"})})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>a});var n=t(6540);const s={},i=n.createContext(s);function o(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a4a33699.4dac9a21.js b/assets/js/a4a33699.4dac9a21.js deleted file mode 100644 index 76ac1cf8ec..0000000000 --- a/assets/js/a4a33699.4dac9a21.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8437],{2211:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var n=s(4848),o=s(8453);const t={},c="Interface: AwaitMessagesOptions",i={id:"reference/structures/Collector/interfaces/AwaitMessagesOptions",title:"Interface: AwaitMessagesOptions",description:"Options to be applied to the collector.",source:"@site/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",sourceDirName:"reference/structures/Collector/interfaces",slug:"/reference/structures/Collector/interfaces/AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Collector",permalink:"/docs/reference/structures/Collector/classes/Collector"},next:{title:"Interface: CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions"}},l={},d=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose?",id:"dispose",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"errors?",id:"errors",level:3},{value:"idle?",id:"idle",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"max?",id:"max",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"maxProcessed?",id:"maxprocessed",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"time?",id:"time",level:3},{value:"Inherited from",id:"inherited-from-4",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-awaitmessagesoptions",children:"Interface: AwaitMessagesOptions"}),"\n",(0,n.jsx)(r.p,{children:"Options to be applied to the collector."}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"dispose",children:"dispose?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"dispose"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Whether to dispose data when it's deleted"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#dispose",children:(0,n.jsx)(r.code,{children:"dispose"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"errors",children:"errors?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"errors"}),": ",(0,n.jsx)(r.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:'An array of "reasons" that would result in the awaitMessages command to throw an error.'}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"idle",children:"idle?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"idle"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Max time allowed idle"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#idle",children:(0,n.jsx)(r.code,{children:"idle"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"max",children:"max?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"max"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"The maximum amount of items to collect"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#max",children:(0,n.jsx)(r.code,{children:"max"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"maxprocessed",children:"maxProcessed?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"maxProcessed"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"The maximum amount of items to process"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#maxprocessed",children:(0,n.jsx)(r.code,{children:"maxProcessed"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"time",children:"time?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"time"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Max time to wait for items in milliseconds"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#time",children:(0,n.jsx)(r.code,{children:"time"})})]})]})}function a(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>i});var n=s(6540);const o={},t=n.createContext(o);function c(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a4a33699.6836815f.js b/assets/js/a4a33699.6836815f.js new file mode 100644 index 0000000000..1c6cca4321 --- /dev/null +++ b/assets/js/a4a33699.6836815f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8437],{2211:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var n=s(4848),o=s(8453);const t={},c="Interface: AwaitMessagesOptions",i={id:"reference/structures/Collector/interfaces/AwaitMessagesOptions",title:"Interface: AwaitMessagesOptions",description:"Options to be applied to the collector.",source:"@site/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",sourceDirName:"reference/structures/Collector/interfaces",slug:"/reference/structures/Collector/interfaces/AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Collector",permalink:"/docs/reference/structures/Collector/classes/Collector"},next:{title:"Interface: CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions"}},l={},d=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose?",id:"dispose",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"errors?",id:"errors",level:3},{value:"idle?",id:"idle",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"max?",id:"max",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"maxProcessed?",id:"maxprocessed",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"time?",id:"time",level:3},{value:"Inherited from",id:"inherited-from-4",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-awaitmessagesoptions",children:"Interface: AwaitMessagesOptions"})}),"\n",(0,n.jsx)(r.p,{children:"Options to be applied to the collector."}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"dispose",children:"dispose?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"dispose"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Whether to dispose data when it's deleted"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#dispose",children:(0,n.jsx)(r.code,{children:"dispose"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"errors",children:"errors?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"errors"}),": ",(0,n.jsx)(r.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:'An array of "reasons" that would result in the awaitMessages command to throw an error.'}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"idle",children:"idle?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"idle"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Max time allowed idle"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#idle",children:(0,n.jsx)(r.code,{children:"idle"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"max",children:"max?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"max"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"The maximum amount of items to collect"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#max",children:(0,n.jsx)(r.code,{children:"max"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"maxprocessed",children:"maxProcessed?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"maxProcessed"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"The maximum amount of items to process"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#maxprocessed",children:(0,n.jsx)(r.code,{children:"maxProcessed"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"time",children:"time?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"time"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Max time to wait for items in milliseconds"}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,n.jsx)(r.code,{children:"CollectorOptions"})}),".",(0,n.jsx)(r.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions#time",children:(0,n.jsx)(r.code,{children:"time"})})]})]})}function a(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>i});var n=s(6540);const o={},t=n.createContext(o);function c(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a6aa9e1f.b4bffb9d.js b/assets/js/a6aa9e1f.b4bffb9d.js new file mode 100644 index 0000000000..85ae71a8ff --- /dev/null +++ b/assets/js/a6aa9e1f.b4bffb9d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7643],{5124:(e,t,a)=>{a.r(t),a.d(t,{default:()=>j});a(6540);var n=a(4164),s=a(4586),r=a(5500),i=a(7559),l=a(8027),o=a(7713),c=a(1463),d=a(3892),g=a(5260),m=a(4096),u=a(4848);function h(e){const t=(0,m.kJ)(e);return(0,u.jsx)(g.A,{children:(0,u.jsx)("script",{type:"application/ld+json",children:JSON.stringify(t)})})}function p(e){const{metadata:t}=e,{siteConfig:{title:a}}=(0,s.A)(),{blogDescription:n,blogTitle:i,permalink:l}=t,o="/"===l?a:i;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(r.be,{title:o,description:n}),(0,u.jsx)(c.A,{tag:"blog_posts_list"})]})}function x(e){const{metadata:t,items:a,sidebar:n}=e;return(0,u.jsxs)(l.A,{sidebar:n,children:[(0,u.jsx)(d.A,{items:a}),(0,u.jsx)(o.A,{metadata:t})]})}function j(e){return(0,u.jsxs)(r.e3,{className:(0,n.A)(i.G.wrapper.blogPages,i.G.page.blogListPage),children:[(0,u.jsx)(p,{...e}),(0,u.jsx)(h,{...e}),(0,u.jsx)(x,{...e})]})}},7713:(e,t,a)=>{a.d(t,{A:()=>i});a(6540);var n=a(1312),s=a(9022),r=a(4848);function i(e){const{metadata:t}=e,{previousPage:a,nextPage:i}=t;return(0,r.jsxs)("nav",{className:"pagination-nav","aria-label":(0,n.T)({id:"theme.blog.paginator.navAriaLabel",message:"Blog list page navigation",description:"The ARIA label for the blog pagination"}),children:[a&&(0,r.jsx)(s.A,{permalink:a,title:(0,r.jsx)(n.A,{id:"theme.blog.paginator.newerEntries",description:"The label used to navigate to the newer blog posts page (previous page)",children:"Newer entries"})}),i&&(0,r.jsx)(s.A,{permalink:i,title:(0,r.jsx)(n.A,{id:"theme.blog.paginator.olderEntries",description:"The label used to navigate to the older blog posts page (next page)",children:"Older entries"}),isNext:!0})]})}},2907:(e,t,a)=>{a.d(t,{A:()=>U});a(6540);var n=a(4164),s=a(4096),r=a(4848);function i(e){let{children:t,className:a}=e;return(0,r.jsx)("article",{className:a,children:t})}var l=a(8774);const o={title:"title_f1Hy"};function c(e){let{className:t}=e;const{metadata:a,isBlogPostPage:i}=(0,s.e7)(),{permalink:c,title:d}=a,g=i?"h1":"h2";return(0,r.jsx)(g,{className:(0,n.A)(o.title,t),children:i?d:(0,r.jsx)(l.A,{to:c,children:d})})}var d=a(1312),g=a(5846),m=a(6266);const u={container:"container_mt6G"};function h(e){let{readingTime:t}=e;const a=function(){const{selectMessage:e}=(0,g.W)();return t=>{const a=Math.ceil(t);return e(a,(0,d.T)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:a}))}}();return(0,r.jsx)(r.Fragment,{children:a(t)})}function p(e){let{date:t,formattedDate:a}=e;return(0,r.jsx)("time",{dateTime:t,children:a})}function x(){return(0,r.jsx)(r.Fragment,{children:" \xb7 "})}function j(e){let{className:t}=e;const{metadata:a}=(0,s.e7)(),{date:i,readingTime:l}=a,o=(0,m.i)({day:"numeric",month:"long",year:"numeric",timeZone:"UTC"});return(0,r.jsxs)("div",{className:(0,n.A)(u.container,"margin-vert--md",t),children:[(0,r.jsx)(p,{date:i,formattedDate:(c=i,o.format(new Date(c)))}),void 0!==l&&(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(x,{}),(0,r.jsx)(h,{readingTime:l})]})]});var c}var A=a(6913);const b={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function f(e){let{className:t}=e;const{metadata:{authors:a},assets:i}=(0,s.e7)();if(0===a.length)return null;const l=a.every((e=>{let{name:t}=e;return!t})),o=1===a.length;return(0,r.jsx)("div",{className:(0,n.A)("margin-top--md margin-bottom--sm",l?b.imageOnlyAuthorRow:"row",t),children:a.map(((e,t)=>(0,r.jsx)("div",{className:(0,n.A)(!l&&(o?"col col--12":"col col--6"),l?b.imageOnlyAuthorCol:b.authorCol),children:(0,r.jsx)(A.A,{author:{...e,imageURL:i.authorsImageUrls[t]??e.imageURL}})},t)))})}function v(){return(0,r.jsxs)("header",{children:[(0,r.jsx)(c,{}),(0,r.jsx)(j,{}),(0,r.jsx)(f,{})]})}var N=a(440),_=a(8509);function T(e){let{children:t,className:a}=e;const{isBlogPostPage:i}=(0,s.e7)();return(0,r.jsx)("div",{id:i?N.LU:void 0,className:(0,n.A)("markdown",a),children:(0,r.jsx)(_.A,{children:t})})}var k=a(7559),w=a(4336),y=a(2053);function P(){return(0,r.jsx)("b",{children:(0,r.jsx)(d.A,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts",children:"Read more"})})}function R(e){const{blogPostTitle:t,...a}=e;return(0,r.jsx)(l.A,{"aria-label":(0,d.T)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t}),...a,children:(0,r.jsx)(P,{})})}function C(){const{metadata:e,isBlogPostPage:t}=(0,s.e7)(),{tags:a,title:i,editUrl:l,hasTruncateMarker:o,lastUpdatedBy:c,lastUpdatedAt:d}=e,g=!t&&o,m=a.length>0;if(!(m||g||l))return null;if(t){const e=!!(l||d||c);return(0,r.jsxs)("footer",{className:"docusaurus-mt-lg",children:[m&&(0,r.jsx)("div",{className:(0,n.A)("row","margin-top--sm",k.G.blog.blogFooterEditMetaRow),children:(0,r.jsx)("div",{className:"col",children:(0,r.jsx)(y.A,{tags:a})})}),e&&(0,r.jsx)(w.A,{className:(0,n.A)("margin-top--sm",k.G.blog.blogFooterEditMetaRow),editUrl:l,lastUpdatedAt:d,lastUpdatedBy:c})]})}return(0,r.jsxs)("footer",{className:"row docusaurus-mt-lg",children:[m&&(0,r.jsx)("div",{className:(0,n.A)("col",{"col--9":g}),children:(0,r.jsx)(y.A,{tags:a})}),g&&(0,r.jsx)("div",{className:(0,n.A)("col text--right",{"col--3":m}),children:(0,r.jsx)(R,{blogPostTitle:i,to:e.permalink})})]})}function U(e){let{children:t,className:a}=e;const l=function(){const{isBlogPostPage:e}=(0,s.e7)();return e?void 0:"margin-bottom--xl"}();return(0,r.jsxs)(i,{className:(0,n.A)(l,a),children:[(0,r.jsx)(v,{}),(0,r.jsx)(T,{children:t}),(0,r.jsx)(C,{})]})}},3892:(e,t,a)=>{a.d(t,{A:()=>i});a(6540);var n=a(4096),s=a(2907),r=a(4848);function i(e){let{items:t,component:a=s.A}=e;return(0,r.jsx)(r.Fragment,{children:t.map((e=>{let{content:t}=e;return(0,r.jsx)(n.in,{content:t,children:(0,r.jsx)(a,{children:(0,r.jsx)(t,{})})},t.metadata.permalink)}))})}},9022:(e,t,a)=>{a.d(t,{A:()=>i});a(6540);var n=a(4164),s=a(8774),r=a(4848);function i(e){const{permalink:t,title:a,subLabel:i,isNext:l}=e;return(0,r.jsxs)(s.A,{className:(0,n.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[i&&(0,r.jsx)("div",{className:"pagination-nav__sublabel",children:i}),(0,r.jsx)("div",{className:"pagination-nav__label",children:a})]})}},6133:(e,t,a)=>{a.d(t,{A:()=>l});a(6540);var n=a(4164),s=a(8774);const r={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var i=a(4848);function l(e){let{permalink:t,label:a,count:l,description:o}=e;return(0,i.jsxs)(s.A,{href:t,title:o,className:(0,n.A)(r.tag,l?r.tagWithCount:r.tagRegular),children:[a,l&&(0,i.jsx)("span",{children:l})]})}},2053:(e,t,a)=>{a.d(t,{A:()=>o});a(6540);var n=a(4164),s=a(1312),r=a(6133);const i={tags:"tags_jXut",tag:"tag_QGVx"};var l=a(4848);function o(e){let{tags:t}=e;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("b",{children:(0,l.jsx)(s.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,l.jsx)("ul",{className:(0,n.A)(i.tags,"padding--none","margin-left--sm"),children:t.map((e=>(0,l.jsx)("li",{className:i.tag,children:(0,l.jsx)(r.A,{...e})},e.permalink)))})]})}},4037:(e,t,a)=>{a.d(t,{A:()=>s});a(6540);var n=a(3028);a(4848);const s={...n.A,license:n.A.note}},890:(e,t,a)=>{a.d(t,{A:()=>r});a(6540);var n=a(4741),s=a(4848);function r(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,s.jsx)(n.A,{icon:"\ud83c\udfc5",...e}):(0,s.jsx)(s.Fragment,{children:(0,s.jsx)(n.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/a6aa9e1f.c0118b8c.js b/assets/js/a6aa9e1f.c0118b8c.js deleted file mode 100644 index a95ee89a4c..0000000000 --- a/assets/js/a6aa9e1f.c0118b8c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7643],{5124:(e,t,n)=>{n.r(t),n.d(t,{default:()=>f});n(6540);var a=n(4164),i=n(4586),r=n(5500),o=n(7559),s=n(6535),l=n(7713),d=n(1463),c=n(3892),g=n(5260),p=n(6676),u=n(4848);function m(e){const t=(0,p.k)(e);return(0,u.jsx)(g.A,{children:(0,u.jsx)("script",{type:"application/ld+json",children:JSON.stringify(t)})})}function h(e){const{metadata:t}=e,{siteConfig:{title:n}}=(0,i.A)(),{blogDescription:a,blogTitle:o,permalink:s}=t,l="/"===s?n:o;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(r.be,{title:l,description:a}),(0,u.jsx)(d.A,{tag:"blog_posts_list"})]})}function b(e){const{metadata:t,items:n,sidebar:a}=e;return(0,u.jsxs)(s.A,{sidebar:a,children:[(0,u.jsx)(c.A,{items:n}),(0,u.jsx)(l.A,{metadata:t})]})}function f(e){return(0,u.jsxs)(r.e3,{className:(0,a.A)(o.G.wrapper.blogPages,o.G.page.blogListPage),children:[(0,u.jsx)(h,{...e}),(0,u.jsx)(m,{...e}),(0,u.jsx)(b,{...e})]})}},7713:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var a=n(1312),i=n(9022),r=n(4848);function o(e){const{metadata:t}=e,{previousPage:n,nextPage:o}=t;return(0,r.jsxs)("nav",{className:"pagination-nav","aria-label":(0,a.T)({id:"theme.blog.paginator.navAriaLabel",message:"Blog list page navigation",description:"The ARIA label for the blog pagination"}),children:[n&&(0,r.jsx)(i.A,{permalink:n,title:(0,r.jsx)(a.A,{id:"theme.blog.paginator.newerEntries",description:"The label used to navigate to the newer blog posts page (previous page)",children:"Newer Entries"})}),o&&(0,r.jsx)(i.A,{permalink:o,title:(0,r.jsx)(a.A,{id:"theme.blog.paginator.olderEntries",description:"The label used to navigate to the older blog posts page (next page)",children:"Older Entries"}),isNext:!0})]})}},3892:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var a=n(7131),i=n(4651),r=n(4848);function o(e){let{items:t,component:n=i.A}=e;return(0,r.jsx)(r.Fragment,{children:t.map((e=>{let{content:t}=e;return(0,r.jsx)(a.i,{content:t,children:(0,r.jsx)(n,{children:(0,r.jsx)(t,{})})},t.metadata.permalink)}))})}},6676:(e,t,n)=>{n.d(t,{k:()=>c,J:()=>g});var a=n(6025),i=n(4586),r=n(6803);var o=n(7131);const s=e=>new Date(e).toISOString();function l(e){const t=e.map(p);return{author:1===t.length?t[0]:t}}function d(e,t,n){return e?{image:u({imageUrl:t(e,{absolute:!0}),caption:`title image for the blog post: ${n}`})}:{}}function c(e){const{siteConfig:t}=(0,i.A)(),{withBaseUrl:n}=(0,a.hH)(),{metadata:{blogDescription:r,blogTitle:o,permalink:c}}=e,g=`${t.url}${c}`;return{"@context":"https://schema.org","@type":"Blog","@id":g,mainEntityOfPage:g,headline:o,description:r,blogPost:e.items.map((e=>function(e,t,n){const{assets:a,frontMatter:i,metadata:r}=e,{date:o,title:c,description:g,lastUpdatedAt:p}=r,u=a.image??i.image,m=i.keywords??[],h=`${t.url}${r.permalink}`,b=p?s(p):void 0;return{"@type":"BlogPosting","@id":h,mainEntityOfPage:h,url:h,headline:c,name:c,description:g,datePublished:o,...b?{dateModified:b}:{},...l(r.authors),...d(u,n,c),...m?{keywords:m}:{}}}(e.content,t,n)))}}function g(){const e=function(){const e=(0,r.A)(),t=e?.data?.blogMetadata;if(!t)throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");return t}(),{assets:t,metadata:n}=(0,o.e)(),{siteConfig:c}=(0,i.A)(),{withBaseUrl:g}=(0,a.hH)(),{date:p,title:u,description:m,frontMatter:h,lastUpdatedAt:b}=n,f=t.image??h.image,x=h.keywords??[],A=b?s(b):void 0,j=`${c.url}${n.permalink}`;return{"@context":"https://schema.org","@type":"BlogPosting","@id":j,mainEntityOfPage:j,url:j,headline:u,name:u,description:m,datePublished:p,...A?{dateModified:A}:{},...l(n.authors),...d(f,g,u),...x?{keywords:x}:{},isPartOf:{"@type":"Blog","@id":`${c.url}${e.blogBasePath}`,name:e.blogTitle}}}function p(e){return{"@type":"Person",...e.name?{name:e.name}:{},...e.title?{description:e.title}:{},...e.url?{url:e.url}:{},...e.email?{email:e.email}:{},...e.imageURL?{image:e.imageURL}:{}}}function u(e){let{imageUrl:t,caption:n}=e;return{"@type":"ImageObject","@id":t,url:t,contentUrl:t,caption:n}}},4037:(e,t,n)=>{n.d(t,{A:()=>i});n(6540);var a=n(3028);n(4848);const i={...a.A,license:a.A.note}},890:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var a=n(4741),i=n(4848);function r(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,i.jsx)(a.A,{icon:"\ud83c\udfc5",...e}):(0,i.jsx)(i.Fragment,{children:(0,i.jsx)(a.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/a7bd4aaa.652b26b5.js b/assets/js/a7bd4aaa.652b26b5.js new file mode 100644 index 0000000000..940a0e0a0b --- /dev/null +++ b/assets/js/a7bd4aaa.652b26b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7098],{4532:(n,e,s)=>{s.r(e),s.d(e,{default:()=>d});s(6540);var r=s(5500),o=s(2565),t=s(3025),c=s(2831),i=s(1463),u=s(4848);function a(n){const{version:e}=n;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(i.A,{version:e.version,tag:(0,o.k)(e.pluginId,e.version)}),(0,u.jsx)(r.be,{children:e.noIndex&&(0,u.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function l(n){const{version:e,route:s}=n;return(0,u.jsx)(r.e3,{className:e.className,children:(0,u.jsx)(t.n,{version:e,children:(0,c.v)(s.routes)})})}function d(n){return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(a,{...n}),(0,u.jsx)(l,{...n})]})}}}]); \ No newline at end of file diff --git a/assets/js/a7bd4aaa.cc62648a.js b/assets/js/a7bd4aaa.cc62648a.js deleted file mode 100644 index 94b36152e5..0000000000 --- a/assets/js/a7bd4aaa.cc62648a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7098],{4532:(n,e,s)=>{s.r(e),s.d(e,{default:()=>d});s(6540);var r=s(5500),o=s(2967),t=s(2252),c=s(2831),i=s(1463),u=s(4848);function a(n){const{version:e}=n;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(i.A,{version:e.version,tag:(0,o.tU)(e.pluginId,e.version)}),(0,u.jsx)(r.be,{children:e.noIndex&&(0,u.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function l(n){const{version:e,route:s}=n;return(0,u.jsx)(r.e3,{className:e.className,children:(0,u.jsx)(t.n,{version:e,children:(0,c.v)(s.routes)})})}function d(n){return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(a,{...n}),(0,u.jsx)(l,{...n})]})}}}]); \ No newline at end of file diff --git a/assets/js/a8e44dab.8c1bfc33.js b/assets/js/a8e44dab.8c1bfc33.js deleted file mode 100644 index 4bd57be38e..0000000000 --- a/assets/js/a8e44dab.8c1bfc33.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6262],{9225:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var r=s(4848),i=s(8453);const c={},d="Interface: ReactionSender",t={id:"reference/api/model/message/interfaces/ReactionSender",title:"Interface: ReactionSender",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/ReactionSender.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"},next:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"isSendFailure",id:"issendfailure",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"t?",id:"t",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-reactionsender",children:"Interface: ReactionSender"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issendfailure",children:"isSendFailure"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSendFailure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message being reacted to"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction was seen/read"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the sender of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"t"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>t});var r=s(6540);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8e44dab.a0444047.js b/assets/js/a8e44dab.a0444047.js new file mode 100644 index 0000000000..7d7226ecff --- /dev/null +++ b/assets/js/a8e44dab.a0444047.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6262],{9225:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>o});var r=s(4848),i=s(8453);const d={},c="Interface: ReactionSender",t={id:"reference/api/model/message/interfaces/ReactionSender",title:"Interface: ReactionSender",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/ReactionSender.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"},next:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"isSendFailure",id:"issendfailure",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"t?",id:"t",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-reactionsender",children:"Interface: ReactionSender"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issendfailure",children:"isSendFailure"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSendFailure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message being reacted to"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction was seen/read"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the sender of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"t"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>t});var r=s(6540);const i={},d=r.createContext(i);function c(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a94703ab.2e71bc13.js b/assets/js/a94703ab.2e71bc13.js deleted file mode 100644 index 550fcdc365..0000000000 --- a/assets/js/a94703ab.2e71bc13.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9048],{2559:(e,t,n)=>{n.r(t),n.d(t,{default:()=>be});var a=n(6540),o=n(4164),i=n(5500),s=n(7559),l=n(4142),r=n(6588),c=n(1312),d=n(3104),u=n(5062);const m={backToTopButton:"backToTopButton_sjWU",backToTopButtonShow:"backToTopButtonShow_xfvO"};var b=n(4848);function h(){const{shown:e,scrollToTop:t}=function(e){let{threshold:t}=e;const[n,o]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:l}=(0,d.gk)();return(0,d.Mq)(((e,n)=>{let{scrollY:a}=e;const s=n?.scrollY;s&&(i.current?i.current=!1:a>=s?(l(),o(!1)):a{e.location.hash&&(i.current=!0,o(!1))})),{shown:n,scrollToTop:()=>s(0)}}({threshold:300});return(0,b.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,o.A)("clean-btn",s.G.common.backToTopButton,m.backToTopButton,e&&m.backToTopButtonShow),type:"button",onClick:t})}var p=n(3109),x=n(6347),f=n(4581),j=n(6342),v=n(3465);function _(e){return(0,b.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,b.jsxs)("g",{fill:"#7a7a7a",children:[(0,b.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,b.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const A={collapseSidebarButton:"collapseSidebarButton_PEFL",collapseSidebarButtonIcon:"collapseSidebarButtonIcon_kv0_"};function g(e){let{onClick:t}=e;return(0,b.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,o.A)("button button--secondary button--outline",A.collapseSidebarButton),onClick:t,children:(0,b.jsx)(_,{className:A.collapseSidebarButtonIcon})})}var k=n(5041),C=n(9532);const S=Symbol("EmptyContext"),T=a.createContext(S);function N(e){let{children:t}=e;const[n,o]=(0,a.useState)(null),i=(0,a.useMemo)((()=>({expandedItem:n,setExpandedItem:o})),[n]);return(0,b.jsx)(T.Provider,{value:i,children:t})}var I=n(1422),B=n(9169),y=n(8774),w=n(2303);function L(e){let{collapsed:t,categoryLabel:n,onClick:a}=e;return(0,b.jsx)("button",{"aria-label":t?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:n}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:n}),"aria-expanded":!t,type:"button",className:"clean-btn menu__caret",onClick:a})}function E(e){let{item:t,onItemClick:n,activePath:i,level:r,index:c,...d}=e;const{items:u,label:m,collapsible:h,className:p,href:x}=t,{docs:{sidebar:{autoCollapseCategories:f}}}=(0,j.p)(),v=function(e){const t=(0,w.A)();return(0,a.useMemo)((()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0),[e,t])}(t),_=(0,l.w8)(t,i),A=(0,B.ys)(x,i),{collapsed:g,setCollapsed:k}=(0,I.u)({initialState:()=>!!h&&(!_&&t.collapsed)}),{expandedItem:N,setExpandedItem:E}=function(){const e=(0,a.useContext)(T);if(e===S)throw new C.dV("DocSidebarItemsExpandedStateProvider");return e}(),M=function(e){void 0===e&&(e=!g),E(e?null:c),k(e)};return function(e){let{isActive:t,collapsed:n,updateCollapsed:o}=e;const i=(0,C.ZC)(t);(0,a.useEffect)((()=>{t&&!i&&n&&o(!1)}),[t,i,n,o])}({isActive:_,collapsed:g,updateCollapsed:M}),(0,a.useEffect)((()=>{h&&null!=N&&N!==c&&f&&k(!0)}),[h,N,c,k,f]),(0,b.jsxs)("li",{className:(0,o.A)(s.G.docs.docSidebarItemCategory,s.G.docs.docSidebarItemCategoryLevel(r),"menu__list-item",{"menu__list-item--collapsed":g},p),children:[(0,b.jsxs)("div",{className:(0,o.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":A}),children:[(0,b.jsx)(y.A,{className:(0,o.A)("menu__link",{"menu__link--sublist":h,"menu__link--sublist-caret":!x&&h,"menu__link--active":_}),onClick:h?e=>{n?.(t),x?M(!1):(e.preventDefault(),M())}:()=>{n?.(t)},"aria-current":A?"page":void 0,role:h&&!x?"button":void 0,"aria-expanded":h&&!x?!g:void 0,href:h?v??"#":v,...d,children:m}),x&&h&&(0,b.jsx)(L,{collapsed:g,categoryLabel:m,onClick:e=>{e.preventDefault(),M()}})]}),(0,b.jsx)(I.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:g,children:(0,b.jsx)(U,{items:u,tabIndex:g?-1:0,onItemClick:n,activePath:i,level:r+1})})]})}var M=n(6654),H=n(3186);const G={menuExternalLink:"menuExternalLink_NmtK"};function W(e){let{item:t,onItemClick:n,activePath:a,level:i,index:r,...c}=e;const{href:d,label:u,className:m,autoAddBaseUrl:h}=t,p=(0,l.w8)(t,a),x=(0,M.A)(d);return(0,b.jsx)("li",{className:(0,o.A)(s.G.docs.docSidebarItemLink,s.G.docs.docSidebarItemLinkLevel(i),"menu__list-item",m),children:(0,b.jsxs)(y.A,{className:(0,o.A)("menu__link",!x&&G.menuExternalLink,{"menu__link--active":p}),autoAddBaseUrl:h,"aria-current":p?"page":void 0,to:d,...x&&{onClick:n?()=>n(t):void 0},...c,children:[u,!x&&(0,b.jsx)(H.A,{})]})},u)}const P={menuHtmlItem:"menuHtmlItem_M9Kj"};function R(e){let{item:t,level:n,index:a}=e;const{value:i,defaultStyle:l,className:r}=t;return(0,b.jsx)("li",{className:(0,o.A)(s.G.docs.docSidebarItemLink,s.G.docs.docSidebarItemLinkLevel(n),l&&[P.menuHtmlItem,"menu__list-item"],r),dangerouslySetInnerHTML:{__html:i}},a)}function D(e){let{item:t,...n}=e;switch(t.type){case"category":return(0,b.jsx)(E,{item:t,...n});case"html":return(0,b.jsx)(R,{item:t,...n});default:return(0,b.jsx)(W,{item:t,...n})}}function F(e){let{items:t,...n}=e;const a=(0,l.Y)(t,n.activePath);return(0,b.jsx)(N,{children:a.map(((e,t)=>(0,b.jsx)(D,{item:e,index:t,...n},t)))})}const U=(0,a.memo)(F),V={menu:"menu_SIkG",menuWithAnnouncementBar:"menuWithAnnouncementBar_GW3s"};function Y(e){let{path:t,sidebar:n,className:i}=e;const l=function(){const{isActive:e}=(0,k.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)((t=>{let{scrollY:a}=t;e&&n(0===a)}),[e]),e&&t}();return(0,b.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,o.A)("menu thin-scrollbar",V.menu,l&&V.menuWithAnnouncementBar,i),children:(0,b.jsx)("ul",{className:(0,o.A)(s.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(U,{items:n,activePath:t,level:1})})})}const K="sidebar_njMd",z="sidebarWithHideableNavbar_wUlq",q="sidebarHidden_VK0M",O="sidebarLogo_isFc";function J(e){let{path:t,sidebar:n,onCollapse:a,isHidden:i}=e;const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:l}}}=(0,j.p)();return(0,b.jsxs)("div",{className:(0,o.A)(K,s&&z,i&&q),children:[s&&(0,b.jsx)(v.A,{tabIndex:-1,className:O}),(0,b.jsx)(Y,{path:t,sidebar:n}),l&&(0,b.jsx)(g,{onClick:a})]})}const Q=a.memo(J);var X=n(5600),Z=n(2069);const $=e=>{let{sidebar:t,path:n}=e;const a=(0,Z.M)();return(0,b.jsx)("ul",{className:(0,o.A)(s.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(U,{items:t,activePath:n,onItemClick:e=>{"category"===e.type&&e.href&&a.toggle(),"link"===e.type&&a.toggle()},level:1})})};function ee(e){return(0,b.jsx)(X.GX,{component:$,props:e})}const te=a.memo(ee);function ne(e){const t=(0,f.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,b.jsxs)(b.Fragment,{children:[n&&(0,b.jsx)(Q,{...e}),a&&(0,b.jsx)(te,{...e})]})}const ae={expandButton:"expandButton_TmdG",expandButtonIcon:"expandButtonIcon_i1dp"};function oe(e){let{toggleSidebar:t}=e;return(0,b.jsx)("div",{className:ae.expandButton,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:t,onClick:t,children:(0,b.jsx)(_,{className:ae.expandButtonIcon})})}const ie={docSidebarContainer:"docSidebarContainer_YfHR",docSidebarContainerHidden:"docSidebarContainerHidden_DPk8",sidebarViewport:"sidebarViewport_aRkj"};function se(e){let{children:t}=e;const n=(0,r.t)();return(0,b.jsx)(a.Fragment,{children:t},n?.name??"noSidebar")}function le(e){let{sidebar:t,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}=e;const{pathname:l}=(0,x.zy)(),[r,c]=(0,a.useState)(!1),d=(0,a.useCallback)((()=>{r&&c(!1),!r&&(0,p.O)()&&c(!0),i((e=>!e))}),[i,r]);return(0,b.jsx)("aside",{className:(0,o.A)(s.G.docs.docSidebarContainer,ie.docSidebarContainer,n&&ie.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(ie.docSidebarContainer)&&n&&c(!0)},children:(0,b.jsx)(se,{children:(0,b.jsxs)("div",{className:(0,o.A)(ie.sidebarViewport,r&&ie.sidebarViewportHidden),children:[(0,b.jsx)(ne,{sidebar:t,path:l,onCollapse:d,isHidden:r}),r&&(0,b.jsx)(oe,{toggleSidebar:d})]})})})}const re={docMainContainer:"docMainContainer_TBSr",docMainContainerEnhanced:"docMainContainerEnhanced_lQrH",docItemWrapperEnhanced:"docItemWrapperEnhanced_JWYK"};function ce(e){let{hiddenSidebarContainer:t,children:n}=e;const a=(0,r.t)();return(0,b.jsx)("main",{className:(0,o.A)(re.docMainContainer,(t||!a)&&re.docMainContainerEnhanced),children:(0,b.jsx)("div",{className:(0,o.A)("container padding-top--md padding-bottom--lg",re.docItemWrapper,t&&re.docItemWrapperEnhanced),children:n})})}const de={docRoot:"docRoot_UBD9",docsWrapper:"docsWrapper_hBAB"};function ue(e){let{children:t}=e;const n=(0,r.t)(),[o,i]=(0,a.useState)(!1);return(0,b.jsxs)("div",{className:de.docsWrapper,children:[(0,b.jsx)(h,{}),(0,b.jsxs)("div",{className:de.docRoot,children:[n&&(0,b.jsx)(le,{sidebar:n.items,hiddenSidebarContainer:o,setHiddenSidebarContainer:i}),(0,b.jsx)(ce,{hiddenSidebarContainer:o,children:t})]})]})}var me=n(3363);function be(e){const t=(0,l.B5)(e);if(!t)return(0,b.jsx)(me.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,b.jsx)(i.e3,{className:(0,o.A)(s.G.page.docsDocPage),children:(0,b.jsx)(r.V,{name:a,items:c,children:(0,b.jsx)(ue,{children:n})})})}},3363:(e,t,n)=>{n.d(t,{A:()=>l});n(6540);var a=n(4164),o=n(1312),i=n(1107),s=n(4848);function l(e){let{className:t}=e;return(0,s.jsx)("main",{className:(0,a.A)("container margin-vert--xl",t),children:(0,s.jsx)("div",{className:"row",children:(0,s.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,s.jsx)(i.A,{as:"h1",className:"hero__title",children:(0,s.jsx)(o.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,s.jsx)("p",{children:(0,s.jsx)(o.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,s.jsx)("p",{children:(0,s.jsx)(o.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}}}]); \ No newline at end of file diff --git a/assets/js/a94703ab.33ca7509.js b/assets/js/a94703ab.33ca7509.js new file mode 100644 index 0000000000..ad65e8ff09 --- /dev/null +++ b/assets/js/a94703ab.33ca7509.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9048],{1377:(e,t,n)=>{n.r(t),n.d(t,{default:()=>be});var a=n(6540),o=n(4164),i=n(5500),s=n(7559),l=n(6972),r=n(609),c=n(1312),d=n(3104),u=n(5062);const m={backToTopButton:"backToTopButton_sjWU",backToTopButtonShow:"backToTopButtonShow_xfvO"};var b=n(4848);function h(){const{shown:e,scrollToTop:t}=function(e){let{threshold:t}=e;const[n,o]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:l}=(0,d.gk)();return(0,d.Mq)(((e,n)=>{let{scrollY:a}=e;const s=n?.scrollY;s&&(i.current?i.current=!1:a>=s?(l(),o(!1)):a{e.location.hash&&(i.current=!0,o(!1))})),{shown:n,scrollToTop:()=>s(0)}}({threshold:300});return(0,b.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,o.A)("clean-btn",s.G.common.backToTopButton,m.backToTopButton,e&&m.backToTopButtonShow),type:"button",onClick:t})}var p=n(3109),x=n(6347),f=n(4581),j=n(6342),v=n(3465);function _(e){return(0,b.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,b.jsxs)("g",{fill:"#7a7a7a",children:[(0,b.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,b.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const A={collapseSidebarButton:"collapseSidebarButton_PEFL",collapseSidebarButtonIcon:"collapseSidebarButtonIcon_kv0_"};function g(e){let{onClick:t}=e;return(0,b.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,o.A)("button button--secondary button--outline",A.collapseSidebarButton),onClick:t,children:(0,b.jsx)(_,{className:A.collapseSidebarButtonIcon})})}var k=n(5041),C=n(9532);const S=Symbol("EmptyContext"),T=a.createContext(S);function N(e){let{children:t}=e;const[n,o]=(0,a.useState)(null),i=(0,a.useMemo)((()=>({expandedItem:n,setExpandedItem:o})),[n]);return(0,b.jsx)(T.Provider,{value:i,children:t})}var I=n(1422),B=n(9169),y=n(8774),w=n(2303);function L(e){let{collapsed:t,categoryLabel:n,onClick:a}=e;return(0,b.jsx)("button",{"aria-label":t?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:n}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:n}),"aria-expanded":!t,type:"button",className:"clean-btn menu__caret",onClick:a})}function E(e){let{item:t,onItemClick:n,activePath:i,level:r,index:c,...d}=e;const{items:u,label:m,collapsible:h,className:p,href:x}=t,{docs:{sidebar:{autoCollapseCategories:f}}}=(0,j.p)(),v=function(e){const t=(0,w.A)();return(0,a.useMemo)((()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0),[e,t])}(t),_=(0,l.w8)(t,i),A=(0,B.ys)(x,i),{collapsed:g,setCollapsed:k}=(0,I.u)({initialState:()=>!!h&&(!_&&t.collapsed)}),{expandedItem:N,setExpandedItem:E}=function(){const e=(0,a.useContext)(T);if(e===S)throw new C.dV("DocSidebarItemsExpandedStateProvider");return e}(),M=function(e){void 0===e&&(e=!g),E(e?null:c),k(e)};return function(e){let{isActive:t,collapsed:n,updateCollapsed:o}=e;const i=(0,C.ZC)(t);(0,a.useEffect)((()=>{t&&!i&&n&&o(!1)}),[t,i,n,o])}({isActive:_,collapsed:g,updateCollapsed:M}),(0,a.useEffect)((()=>{h&&null!=N&&N!==c&&f&&k(!0)}),[h,N,c,k,f]),(0,b.jsxs)("li",{className:(0,o.A)(s.G.docs.docSidebarItemCategory,s.G.docs.docSidebarItemCategoryLevel(r),"menu__list-item",{"menu__list-item--collapsed":g},p),children:[(0,b.jsxs)("div",{className:(0,o.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":A}),children:[(0,b.jsx)(y.A,{className:(0,o.A)("menu__link",{"menu__link--sublist":h,"menu__link--sublist-caret":!x&&h,"menu__link--active":_}),onClick:h?e=>{n?.(t),x?M(!1):(e.preventDefault(),M())}:()=>{n?.(t)},"aria-current":A?"page":void 0,role:h&&!x?"button":void 0,"aria-expanded":h&&!x?!g:void 0,href:h?v??"#":v,...d,children:m}),x&&h&&(0,b.jsx)(L,{collapsed:g,categoryLabel:m,onClick:e=>{e.preventDefault(),M()}})]}),(0,b.jsx)(I.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:g,children:(0,b.jsx)(U,{items:u,tabIndex:g?-1:0,onItemClick:n,activePath:i,level:r+1})})]})}var M=n(6654),H=n(3186);const G={menuExternalLink:"menuExternalLink_NmtK"};function W(e){let{item:t,onItemClick:n,activePath:a,level:i,index:r,...c}=e;const{href:d,label:u,className:m,autoAddBaseUrl:h}=t,p=(0,l.w8)(t,a),x=(0,M.A)(d);return(0,b.jsx)("li",{className:(0,o.A)(s.G.docs.docSidebarItemLink,s.G.docs.docSidebarItemLinkLevel(i),"menu__list-item",m),children:(0,b.jsxs)(y.A,{className:(0,o.A)("menu__link",!x&&G.menuExternalLink,{"menu__link--active":p}),autoAddBaseUrl:h,"aria-current":p?"page":void 0,to:d,...x&&{onClick:n?()=>n(t):void 0},...c,children:[u,!x&&(0,b.jsx)(H.A,{})]})},u)}const P={menuHtmlItem:"menuHtmlItem_M9Kj"};function R(e){let{item:t,level:n,index:a}=e;const{value:i,defaultStyle:l,className:r}=t;return(0,b.jsx)("li",{className:(0,o.A)(s.G.docs.docSidebarItemLink,s.G.docs.docSidebarItemLinkLevel(n),l&&[P.menuHtmlItem,"menu__list-item"],r),dangerouslySetInnerHTML:{__html:i}},a)}function D(e){let{item:t,...n}=e;switch(t.type){case"category":return(0,b.jsx)(E,{item:t,...n});case"html":return(0,b.jsx)(R,{item:t,...n});default:return(0,b.jsx)(W,{item:t,...n})}}function F(e){let{items:t,...n}=e;const a=(0,l.Y)(t,n.activePath);return(0,b.jsx)(N,{children:a.map(((e,t)=>(0,b.jsx)(D,{item:e,index:t,...n},t)))})}const U=(0,a.memo)(F),V={menu:"menu_SIkG",menuWithAnnouncementBar:"menuWithAnnouncementBar_GW3s"};function Y(e){let{path:t,sidebar:n,className:i}=e;const l=function(){const{isActive:e}=(0,k.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)((t=>{let{scrollY:a}=t;e&&n(0===a)}),[e]),e&&t}();return(0,b.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,o.A)("menu thin-scrollbar",V.menu,l&&V.menuWithAnnouncementBar,i),children:(0,b.jsx)("ul",{className:(0,o.A)(s.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(U,{items:n,activePath:t,level:1})})})}const K="sidebar_njMd",z="sidebarWithHideableNavbar_wUlq",q="sidebarHidden_VK0M",O="sidebarLogo_isFc";function J(e){let{path:t,sidebar:n,onCollapse:a,isHidden:i}=e;const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:l}}}=(0,j.p)();return(0,b.jsxs)("div",{className:(0,o.A)(K,s&&z,i&&q),children:[s&&(0,b.jsx)(v.A,{tabIndex:-1,className:O}),(0,b.jsx)(Y,{path:t,sidebar:n}),l&&(0,b.jsx)(g,{onClick:a})]})}const Q=a.memo(J);var X=n(5600),Z=n(2069);const $=e=>{let{sidebar:t,path:n}=e;const a=(0,Z.M)();return(0,b.jsx)("ul",{className:(0,o.A)(s.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(U,{items:t,activePath:n,onItemClick:e=>{"category"===e.type&&e.href&&a.toggle(),"link"===e.type&&a.toggle()},level:1})})};function ee(e){return(0,b.jsx)(X.GX,{component:$,props:e})}const te=a.memo(ee);function ne(e){const t=(0,f.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,b.jsxs)(b.Fragment,{children:[n&&(0,b.jsx)(Q,{...e}),a&&(0,b.jsx)(te,{...e})]})}const ae={expandButton:"expandButton_TmdG",expandButtonIcon:"expandButtonIcon_i1dp"};function oe(e){let{toggleSidebar:t}=e;return(0,b.jsx)("div",{className:ae.expandButton,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:t,onClick:t,children:(0,b.jsx)(_,{className:ae.expandButtonIcon})})}const ie={docSidebarContainer:"docSidebarContainer_YfHR",docSidebarContainerHidden:"docSidebarContainerHidden_DPk8",sidebarViewport:"sidebarViewport_aRkj"};function se(e){let{children:t}=e;const n=(0,r.t)();return(0,b.jsx)(a.Fragment,{children:t},n?.name??"noSidebar")}function le(e){let{sidebar:t,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}=e;const{pathname:l}=(0,x.zy)(),[r,c]=(0,a.useState)(!1),d=(0,a.useCallback)((()=>{r&&c(!1),!r&&(0,p.O)()&&c(!0),i((e=>!e))}),[i,r]);return(0,b.jsx)("aside",{className:(0,o.A)(s.G.docs.docSidebarContainer,ie.docSidebarContainer,n&&ie.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(ie.docSidebarContainer)&&n&&c(!0)},children:(0,b.jsx)(se,{children:(0,b.jsxs)("div",{className:(0,o.A)(ie.sidebarViewport,r&&ie.sidebarViewportHidden),children:[(0,b.jsx)(ne,{sidebar:t,path:l,onCollapse:d,isHidden:r}),r&&(0,b.jsx)(oe,{toggleSidebar:d})]})})})}const re={docMainContainer:"docMainContainer_TBSr",docMainContainerEnhanced:"docMainContainerEnhanced_lQrH",docItemWrapperEnhanced:"docItemWrapperEnhanced_JWYK"};function ce(e){let{hiddenSidebarContainer:t,children:n}=e;const a=(0,r.t)();return(0,b.jsx)("main",{className:(0,o.A)(re.docMainContainer,(t||!a)&&re.docMainContainerEnhanced),children:(0,b.jsx)("div",{className:(0,o.A)("container padding-top--md padding-bottom--lg",re.docItemWrapper,t&&re.docItemWrapperEnhanced),children:n})})}const de={docRoot:"docRoot_UBD9",docsWrapper:"docsWrapper_hBAB"};function ue(e){let{children:t}=e;const n=(0,r.t)(),[o,i]=(0,a.useState)(!1);return(0,b.jsxs)("div",{className:de.docsWrapper,children:[(0,b.jsx)(h,{}),(0,b.jsxs)("div",{className:de.docRoot,children:[n&&(0,b.jsx)(le,{sidebar:n.items,hiddenSidebarContainer:o,setHiddenSidebarContainer:i}),(0,b.jsx)(ce,{hiddenSidebarContainer:o,children:t})]})]})}var me=n(3363);function be(e){const t=(0,l.B5)(e);if(!t)return(0,b.jsx)(me.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,b.jsx)(i.e3,{className:(0,o.A)(s.G.page.docsDocPage),children:(0,b.jsx)(r.V,{name:a,items:c,children:(0,b.jsx)(ue,{children:n})})})}},3363:(e,t,n)=>{n.d(t,{A:()=>l});n(6540);var a=n(4164),o=n(1312),i=n(1107),s=n(4848);function l(e){let{className:t}=e;return(0,s.jsx)("main",{className:(0,a.A)("container margin-vert--xl",t),children:(0,s.jsx)("div",{className:"row",children:(0,s.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,s.jsx)(i.A,{as:"h1",className:"hero__title",children:(0,s.jsx)(o.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,s.jsx)("p",{children:(0,s.jsx)(o.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,s.jsx)("p",{children:(0,s.jsx)(o.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}}}]); \ No newline at end of file diff --git a/assets/js/acb0ea1f.83caf7e2.js b/assets/js/acb0ea1f.83caf7e2.js new file mode 100644 index 0000000000..6ae7a56406 --- /dev/null +++ b/assets/js/acb0ea1f.83caf7e2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7898],{7469:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var n=r(4848),o=r(8453);const c={},i="controllers/init_patch",s={id:"reference/controllers/init_patch/index",title:"controllers/init\\_patch",description:"",source:"@site/docs/reference/controllers/init_patch/index.md",sourceDirName:"reference/controllers/init_patch",slug:"/reference/controllers/init_patch/",permalink:"/docs/reference/controllers/init_patch/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/init_patch/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: ev",permalink:"/docs/reference/controllers/events/variables/ev"},next:{title:"controllers/initializer",permalink:"/docs/reference/controllers/initializer/"}},a={},l=[];function d(e){const t={h1:"h1",header:"header",...(0,o.R)(),...e.components};return(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"controllersinit_patch",children:"controllers/init_patch"})})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>s});var n=r(6540);const o={},c=n.createContext(o);function i(e){const t=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/acb0ea1f.a0a0dad6.js b/assets/js/acb0ea1f.a0a0dad6.js deleted file mode 100644 index d82a0a1596..0000000000 --- a/assets/js/acb0ea1f.a0a0dad6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7898],{7469:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>s,toc:()=>a});var r=n(4848),o=n(8453);const c={},i="controllers/init_patch",s={id:"reference/controllers/init_patch/index",title:"controllers/init\\_patch",description:"",source:"@site/docs/reference/controllers/init_patch/index.md",sourceDirName:"reference/controllers/init_patch",slug:"/reference/controllers/init_patch/",permalink:"/docs/reference/controllers/init_patch/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/init_patch/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: ev",permalink:"/docs/reference/controllers/events/variables/ev"},next:{title:"controllers/initializer",permalink:"/docs/reference/controllers/initializer/"}},l={},a=[];function u(e){const t={h1:"h1",...(0,o.R)(),...e.components};return(0,r.jsx)(t.h1,{id:"controllersinit_patch",children:"controllers/init_patch"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>s});var r=n(6540);const o={},c=r.createContext(o);function i(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/acecf23e.92dddac5.js b/assets/js/acecf23e.28f9a35b.js similarity index 66% rename from assets/js/acecf23e.92dddac5.js rename to assets/js/acecf23e.28f9a35b.js index 251c76b68a..693f387f9f 100644 --- a/assets/js/acecf23e.92dddac5.js +++ b/assets/js/acecf23e.28f9a35b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1903],{1912:s=>{s.exports=JSON.parse('{"blogBasePath":"/blog","blogTitle":"Blog"}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1903],{1912:s=>{s.exports=JSON.parse('{"blogBasePath":"/blog","blogTitle":"Blog","authorsListPath":"/blog/authors"}')}}]); \ No newline at end of file diff --git a/assets/js/ae1c8c73.414adc65.js b/assets/js/ae1c8c73.414adc65.js new file mode 100644 index 0000000000..944618d09d --- /dev/null +++ b/assets/js/ae1c8c73.414adc65.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7492],{1388:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const r={},i="Type Alias: Base64",o={id:"reference/api/model/aliases/type-aliases/Base64",title:"Type Alias: Base64",description:"Base64: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/Base64.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/Base64.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile"},next:{title:"Type Alias: ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId"}},c={},l=[];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"type-alias-base64",children:"Type Alias: Base64"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Base64"}),": ",(0,t.jsx)(s.code,{children:"Brand"}),"<",(0,t.jsx)(s.code,{children:"string"}),", ",(0,t.jsx)(s.code,{children:'"Base64"'}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Base64 is basically a file encoded as a string."}),"\n",(0,t.jsx)(s.p,{children:"Base64 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The term Base64 originates from a specific MIME content transfer encoding."}),"\n",(0,t.jsxs)(s.p,{children:["Learn more here: ",(0,t.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Glossary/Base64",children:"https://developer.mozilla.org/en-US/docs/Glossary/Base64"})]})]})}function p(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>i,x:()=>o});var t=a(6540);const n={},r=t.createContext(n);function i(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae1c8c73.79b8e1cf.js b/assets/js/ae1c8c73.79b8e1cf.js deleted file mode 100644 index c1a96e41af..0000000000 --- a/assets/js/ae1c8c73.79b8e1cf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7492],{1388:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const r={},i="Type Alias: Base64",o={id:"reference/api/model/aliases/type-aliases/Base64",title:"Type Alias: Base64",description:"Base64: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/Base64.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/Base64.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile"},next:{title:"Type Alias: ChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/ChatId"}},c={},l=[];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"type-alias-base64",children:"Type Alias: Base64"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Base64"}),": ",(0,t.jsx)(s.code,{children:"Brand"}),"<",(0,t.jsx)(s.code,{children:"string"}),", ",(0,t.jsx)(s.code,{children:'"Base64"'}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Base64 is basically a file encoded as a string."}),"\n",(0,t.jsx)(s.p,{children:"Base64 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The term Base64 originates from a specific MIME content transfer encoding."}),"\n",(0,t.jsxs)(s.p,{children:["Learn more here: ",(0,t.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Glossary/Base64",children:"https://developer.mozilla.org/en-US/docs/Glossary/Base64"})]})]})}function p(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>i,x:()=>o});var t=a(6540);const n={},r=t.createContext(n);function i(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af80f1f3.2d454e9c.js b/assets/js/af80f1f3.2d454e9c.js new file mode 100644 index 0000000000..5b798513c9 --- /dev/null +++ b/assets/js/af80f1f3.2d454e9c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9772],{7926:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var t=r(4848),c=r(8453);const o={},i="Interface: BizProfileOptions",s={id:"reference/api/model/contact/interfaces/BizProfileOptions",title:"Interface: BizProfileOptions",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory"},next:{title:"Interface: BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cartEnabled",id:"cartenabled",level:3},{value:"commerceExperience",id:"commerceexperience",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-bizprofileoptions",children:"Interface: BizProfileOptions"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cartenabled",children:"cartEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cartEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"commerceexperience",children:"commerceExperience"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"commerceExperience"}),": ",(0,t.jsx)(n.code,{children:'"catalog"'})," | ",(0,t.jsx)(n.code,{children:'"none"'})," | ",(0,t.jsx)(n.code,{children:'"shop"'})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>s});var t=r(6540);const c={},o=t.createContext(c);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af80f1f3.f641b6b6.js b/assets/js/af80f1f3.f641b6b6.js deleted file mode 100644 index 242e6248dc..0000000000 --- a/assets/js/af80f1f3.f641b6b6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9772],{7926:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var t=r(4848),c=r(8453);const o={},i="Interface: BizProfileOptions",s={id:"reference/api/model/contact/interfaces/BizProfileOptions",title:"Interface: BizProfileOptions",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory"},next:{title:"Interface: BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cartEnabled",id:"cartenabled",level:3},{value:"commerceExperience",id:"commerceexperience",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-bizprofileoptions",children:"Interface: BizProfileOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cartenabled",children:"cartEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cartEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"commerceexperience",children:"commerceExperience"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"commerceExperience"}),": ",(0,t.jsx)(n.code,{children:'"catalog"'})," | ",(0,t.jsx)(n.code,{children:'"none"'})," | ",(0,t.jsx)(n.code,{children:'"shop"'})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>s});var t=r(6540);const c={},o=t.createContext(c);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b0030a2c.3c725206.js b/assets/js/b0030a2c.3c725206.js new file mode 100644 index 0000000000..52b57cf659 --- /dev/null +++ b/assets/js/b0030a2c.3c725206.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1422],{7606:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>f,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var o=r(4848),s=r(8453);const t={},c="Interface: DevTools",i={id:"reference/api/model/config/interfaces/DevTools",title:"Interface: DevTools",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/DevTools.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/DevTools.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject"},next:{title:"Interface: EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"pass",id:"pass",level:3},{value:"user",id:"user",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"interface-devtools",children:"Interface: DevTools"})}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"pass",children:"pass"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"pass"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Password for devtools"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"user",children:"user"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"user"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Username for devtools"})]})}function f(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>i});var o=r(6540);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b0030a2c.f40ca3c1.js b/assets/js/b0030a2c.f40ca3c1.js deleted file mode 100644 index 5bf68d768f..0000000000 --- a/assets/js/b0030a2c.f40ca3c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1422],{7606:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>f,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var o=r(4848),s=r(8453);const t={},c="Interface: DevTools",i={id:"reference/api/model/config/interfaces/DevTools",title:"Interface: DevTools",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/DevTools.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/DevTools.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ConfigObject",permalink:"/docs/reference/api/model/config/interfaces/ConfigObject"},next:{title:"Interface: EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"pass",id:"pass",level:3},{value:"user",id:"user",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-devtools",children:"Interface: DevTools"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"pass",children:"pass"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"pass"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Password for devtools"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"user",children:"user"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"user"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Username for devtools"})]})}function f(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>i});var o=r(6540);const s={},t=o.createContext(s);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b123e85d.080a741c.js b/assets/js/b123e85d.080a741c.js new file mode 100644 index 0000000000..fee0b7d96f --- /dev/null +++ b/assets/js/b123e85d.080a741c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3605],{1224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(4848),i=s(8453);const a={},d="Sending Files",o={id:"how-to/send-files",title:"Sending Files",description:"Send Image",source:"@site/docs/how-to/send-files.md",sourceDirName:"how-to",slug:"/how-to/send-files",permalink:"/docs/how-to/send-files",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-files.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Receiving Messages",permalink:"/docs/how-to/receive-messages"},next:{title:"Sending Messages",permalink:"/docs/how-to/send-messages"}},r={},l=[{value:"Send Image",id:"send-image",level:2},{value:"Send Audio",id:"send-audio",level:2},{value:"Send File",id:"send-file",level:2},{value:"Send Stickers",id:"send-stickers",level:2},{value:"Sending Gifs",id:"sending-gifs",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"sending-files",children:"Sending Files"})}),"\n",(0,t.jsx)(n.h2,{id:"send-image",children:"Send Image"}),"\n",(0,t.jsx)(n.p,{children:"[[sendImage]]"}),"\n",(0,t.jsx)(n.p,{children:"Make sure to use a [[DataURL]] for the second parameter."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')\n\n //send image as a reply to another message quotedMessageId\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)\n\n //wait for the Id to be returned\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-audio",children:"Send Audio"}),"\n",(0,t.jsx)(n.p,{children:"[[sendPtt]] sends an audio clip as a 'push to talk' type file. This allows recipients to play the clip as they would any other voice note."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendPtt(chatId, dataUrl)\n\n //Send the audio as reply to a message (quotedMessageId)\n client.sendPtt(chatId, dataUrl, quotedMessageId)\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-file",children:"Send File"}),"\n",(0,t.jsx)(n.p,{children:"[[sendFile]]"}),"\n",(0,t.jsx)(n.p,{children:"[[sendFileFromUrl]]"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf')\n\n //Send the file as reply to a message (quotedMessageId)\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', quotedMessageId)\n\n //Send a file and wait for the message id to be returned\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', null, true)\n\n //or from URL\n client.sendFileFromUrl(chatId, url);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-stickers",children:"Send Stickers"}),"\n",(0,t.jsx)(n.p,{children:"[[sendImageAsSticker]]"}),"\n",(0,t.jsx)(n.p,{children:"[[sendStickerfromUrl]]"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendImageAsSticker(chatId, dataUrl);\n\n //or from a URL\n client.sendStickerfromUrl(chatId, url);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"sending-gifs",children:"Sending Gifs"}),"\n",(0,t.jsx)(n.p,{children:"There are two ways to send GIFs - by Video or by giphy link."}),"\n",(0,t.jsx)(n.p,{children:"WA doesn't actually support the .gif format - probably due to how inefficient it is as a filetype - they instead convert GIFs to video then process them."}),"\n",(0,t.jsx)(n.p,{children:"In order to send gifs you need to do the same (convert the gif to an mp4 file) then use [[sendVideoAsGif]]"}),"\n",(0,t.jsxs)(n.p,{children:["[[sendGiphy]] is a convenience method to make it easier to send gifs from the website ",(0,t.jsx)(n.a,{href:"https://giphy.com",children:"GIPHY"}),". You need to make sure you use a giphy media link as shown below."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"\nimport { create, Client} from '@open-wa/wa-automate';\n\nfunction start(client: Client) {\nawait client.sendVideoAsGif('xyz@c.us','Video FILE DATA URL','some file.mp4', `Hello this is the caption`);\n\n//or send via Giphy URL\n\nawait client.sendGiphy('xyz@c.us','https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif', `Hello this is the caption`);\n}\n\n///IMPORTANT! Please make sure to point to your chrome installation and make sure your host has ffmpeg support\ncreate({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n}).then(client => start(client));\n\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var t=s(6540);const i={},a=t.createContext(i);function d(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b123e85d.76a5ffb6.js b/assets/js/b123e85d.76a5ffb6.js deleted file mode 100644 index 41d1294115..0000000000 --- a/assets/js/b123e85d.76a5ffb6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3605],{1224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>r});var t=s(4848),i=s(8453);const a={},d="Sending Files",o={id:"how-to/send-files",title:"Sending Files",description:"Send Image",source:"@site/docs/how-to/send-files.md",sourceDirName:"how-to",slug:"/how-to/send-files",permalink:"/docs/how-to/send-files",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/send-files.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Receiving Messages",permalink:"/docs/how-to/receive-messages"},next:{title:"Sending Messages",permalink:"/docs/how-to/send-messages"}},l={},r=[{value:"Send Image",id:"send-image",level:2},{value:"Send Audio",id:"send-audio",level:2},{value:"Send File",id:"send-file",level:2},{value:"Send Stickers",id:"send-stickers",level:2},{value:"Sending Gifs",id:"sending-gifs",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"sending-files",children:"Sending Files"}),"\n",(0,t.jsx)(n.h2,{id:"send-image",children:"Send Image"}),"\n",(0,t.jsx)(n.p,{children:"[[sendImage]]"}),"\n",(0,t.jsx)(n.p,{children:"Make sure to use a [[DataURL]] for the second parameter."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')\n\n //send image as a reply to another message quotedMessageId\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)\n\n //wait for the Id to be returned\n client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-audio",children:"Send Audio"}),"\n",(0,t.jsx)(n.p,{children:"[[sendPtt]] sends an audio clip as a 'push to talk' type file. This allows recipients to play the clip as they would any other voice note."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendPtt(chatId, dataUrl)\n\n //Send the audio as reply to a message (quotedMessageId)\n client.sendPtt(chatId, dataUrl, quotedMessageId)\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-file",children:"Send File"}),"\n",(0,t.jsx)(n.p,{children:"[[sendFile]]"}),"\n",(0,t.jsx)(n.p,{children:"[[sendFileFromUrl]]"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf')\n\n //Send the file as reply to a message (quotedMessageId)\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', quotedMessageId)\n\n //Send a file and wait for the message id to be returned\n client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', null, true)\n\n //or from URL\n client.sendFileFromUrl(chatId, url);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"send-stickers",children:"Send Stickers"}),"\n",(0,t.jsx)(n.p,{children:"[[sendImageAsSticker]]"}),"\n",(0,t.jsx)(n.p,{children:"[[sendStickerfromUrl]]"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:" client.sendImageAsSticker(chatId, dataUrl);\n\n //or from a URL\n client.sendStickerfromUrl(chatId, url);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"sending-gifs",children:"Sending Gifs"}),"\n",(0,t.jsx)(n.p,{children:"There are two ways to send GIFs - by Video or by giphy link."}),"\n",(0,t.jsx)(n.p,{children:"WA doesn't actually support the .gif format - probably due to how inefficient it is as a filetype - they instead convert GIFs to video then process them."}),"\n",(0,t.jsx)(n.p,{children:"In order to send gifs you need to do the same (convert the gif to an mp4 file) then use [[sendVideoAsGif]]"}),"\n",(0,t.jsxs)(n.p,{children:["[[sendGiphy]] is a convenience method to make it easier to send gifs from the website ",(0,t.jsx)(n.a,{href:"https://giphy.com",children:"GIPHY"}),". You need to make sure you use a giphy media link as shown below."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"\nimport { create, Client} from '@open-wa/wa-automate';\n\nfunction start(client: Client) {\nawait client.sendVideoAsGif('xyz@c.us','Video FILE DATA URL','some file.mp4', `Hello this is the caption`);\n\n//or send via Giphy URL\n\nawait client.sendGiphy('xyz@c.us','https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif', `Hello this is the caption`);\n}\n\n///IMPORTANT! Please make sure to point to your chrome installation and make sure your host has ffmpeg support\ncreate({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n}).then(client => start(client));\n\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var t=s(6540);const i={},a=t.createContext(i);function d(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b182beed.56541c81.js b/assets/js/b182beed.56541c81.js new file mode 100644 index 0000000000..d936a03d79 --- /dev/null +++ b/assets/js/b182beed.56541c81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4994],{8715:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>a,frontMatter:()=>i,metadata:()=>c,toc:()=>h});var s=r(4848),o=r(8453);const i={},t="Interface: Webhook",c={id:"reference/api/model/config/interfaces/Webhook",title:"Interface: Webhook",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/Webhook.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/Webhook.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData"},next:{title:"Type Alias: AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig"}},d={},h=[{value:"Properties",id:"properties",level:2},{value:"events",id:"events",level:3},{value:"id",id:"id",level:3},{value:"requestConfig?",id:"requestconfig",level:3},{value:"ts",id:"ts",level:3},{value:"url",id:"url",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webhook",children:"Interface: Webhook"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"events"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"events"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,s.jsx)(n.code,{children:"SimpleListener"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An array of events that are registered to be sent to this webhook."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the given webhook setup. Use this ID with [[removeWebhook]]"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"requestconfig",children:"requestConfig?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"requestConfig"}),": ",(0,s.jsx)(n.code,{children:"AxiosRequestConfig"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The optional AxiosRequestConfig to use for firing the webhook event. This can be useful if you want to add some authentication when POSTing data to your server."}),"\n",(0,s.jsxs)(n.p,{children:["For example, if your webhook requires the username ",(0,s.jsx)(n.code,{children:"admin"})," and password ",(0,s.jsx)(n.code,{children:"1234"})," for authentication, you can set the requestConfig to:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n auth: {\n username: "admin",\n password: "1234",\n }\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Please note, for security reasons, this is not returned when listing webhooks however it is returned when registering a webhook for verification purposes."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ts",children:"ts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ts"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Time when the webhook was registered in epoch time"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The endpoint to send (POST) the event to."})]})}function a(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>c});var s=r(6540);const o={},i=s.createContext(o);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b182beed.974ea8c1.js b/assets/js/b182beed.974ea8c1.js deleted file mode 100644 index 7ec089625a..0000000000 --- a/assets/js/b182beed.974ea8c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4994],{8715:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var o=r(4848),s=r(8453);const t={},i="Interface: Webhook",c={id:"reference/api/model/config/interfaces/Webhook",title:"Interface: Webhook",description:"Properties",source:"@site/docs/reference/api/model/config/interfaces/Webhook.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/Webhook",permalink:"/docs/reference/api/model/config/interfaces/Webhook",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/Webhook.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SessionData",permalink:"/docs/reference/api/model/config/interfaces/SessionData"},next:{title:"Type Alias: AdvancedConfig",permalink:"/docs/reference/api/model/config/type-aliases/AdvancedConfig"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"events",id:"events",level:3},{value:"id",id:"id",level:3},{value:"requestConfig?",id:"requestconfig",level:3},{value:"ts",id:"ts",level:3},{value:"url",id:"url",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-webhook",children:"Interface: Webhook"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"events",children:"events"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"events"}),": ",(0,o.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,o.jsx)(n.code,{children:"SimpleListener"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"An array of events that are registered to be sent to this webhook."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"id"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The ID of the given webhook setup. Use this ID with [[removeWebhook]]"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"requestconfig",children:"requestConfig?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"requestConfig"}),": ",(0,o.jsx)(n.code,{children:"AxiosRequestConfig"}),"<",(0,o.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The optional AxiosRequestConfig to use for firing the webhook event. This can be useful if you want to add some authentication when POSTing data to your server."}),"\n",(0,o.jsxs)(n.p,{children:["For example, if your webhook requires the username ",(0,o.jsx)(n.code,{children:"admin"})," and password ",(0,o.jsx)(n.code,{children:"1234"})," for authentication, you can set the requestConfig to:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n auth: {\n username: "admin",\n password: "1234",\n }\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:"Please note, for security reasons, this is not returned when listing webhooks however it is returned when registering a webhook for verification purposes."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"ts",children:"ts"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"ts"}),": ",(0,o.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Time when the webhook was registered in epoch time"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"url"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The endpoint to send (POST) the event to."})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var o=r(6540);const s={},t=o.createContext(s);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b27ebe52.6f81f2dc.js b/assets/js/b27ebe52.6f81f2dc.js new file mode 100644 index 0000000000..995713fb5d --- /dev/null +++ b/assets/js/b27ebe52.6f81f2dc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9457],{4763:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var n=s(4848),t=s(8453);const i={},c="structures/Dialog",a={id:"reference/structures/Dialog/index",title:"structures/Dialog",description:"Index",source:"@site/docs/reference/structures/Dialog/index.md",sourceDirName:"reference/structures/Dialog",slug:"/reference/structures/Dialog/",permalink:"/docs/reference/structures/Dialog/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CollectorFilter()\\",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter"},next:{title:"Enumeration: ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType"}},l={},o=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function u(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"structuresdialog",children:"structures/Dialog"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/enumerations/ValidationType",children:"ValidationType"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",children:"CurrentDialogProps"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogButtons",children:"DialogButtons"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",children:"DialogListMessageRow"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",children:"DialogListMessageSection"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogProperty",children:"DialogProperty"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogState",children:"DialogState"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",children:"DialogTemplate"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogValidation",children:"DialogValidation"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:"CheckFunction"})}),"\n"]})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>a});var n=s(6540);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b27ebe52.a6232ea0.js b/assets/js/b27ebe52.a6232ea0.js deleted file mode 100644 index 665ee9f15f..0000000000 --- a/assets/js/b27ebe52.a6232ea0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9457],{4763:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var n=s(4848),t=s(8453);const i={},c="structures/Dialog",a={id:"reference/structures/Dialog/index",title:"structures/Dialog",description:"Index",source:"@site/docs/reference/structures/Dialog/index.md",sourceDirName:"reference/structures/Dialog",slug:"/reference/structures/Dialog/",permalink:"/docs/reference/structures/Dialog/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CollectorFilter()\\",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter"},next:{title:"Enumeration: ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType"}},l={},o=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function u(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"structuresdialog",children:"structures/Dialog"}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/enumerations/ValidationType",children:"ValidationType"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",children:"CurrentDialogProps"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogButtons",children:"DialogButtons"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",children:"DialogListMessageRow"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",children:"DialogListMessageSection"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogProperty",children:"DialogProperty"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogState",children:"DialogState"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",children:"DialogTemplate"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/interfaces/DialogValidation",children:"DialogValidation"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",children:"CheckFunction"})}),"\n"]})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>a});var n=s(6540);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b2cda8ff.2fcc78bf.js b/assets/js/b2cda8ff.2fcc78bf.js new file mode 100644 index 0000000000..d100bde538 --- /dev/null +++ b/assets/js/b2cda8ff.2fcc78bf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6785],{3794:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=t(4848),i=t(8453);const c={},s="Interface: CartItem",o={id:"reference/api/model/product/interfaces/CartItem",title:"Interface: CartItem",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/CartItem.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/CartItem.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"},next:{title:"Interface: CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"name",id:"name",level:3},{value:"qty",id:"qty",level:3},{value:"thumbnailId",id:"thumbnailid",level:3},{value:"thumbnailUrl",id:"thumbnailurl",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-cartitem",children:"Interface: CartItem"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Product ID"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Product name"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"qty",children:"qty"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"qty"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Amount of this item in the cart"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"thumbnailid",children:"thumbnailId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"thumbnailId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"thumbnailurl",children:"thumbnailUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"thumbnailUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"URL to .enc file of the thumbnail. Just change the filetype to .jpg to view the thumbnail"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>o});var r=t(6540);const i={},c=r.createContext(i);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b2cda8ff.863636ad.js b/assets/js/b2cda8ff.863636ad.js deleted file mode 100644 index 1ebc465fa6..0000000000 --- a/assets/js/b2cda8ff.863636ad.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6785],{3794:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=t(4848),i=t(8453);const c={},s="Interface: CartItem",o={id:"reference/api/model/product/interfaces/CartItem",title:"Interface: CartItem",description:"Properties",source:"@site/docs/reference/api/model/product/interfaces/CartItem.md",sourceDirName:"reference/api/model/product/interfaces",slug:"/reference/api/model/product/interfaces/CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/interfaces/CartItem.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"},next:{title:"Interface: CustomProduct",permalink:"/docs/reference/api/model/product/interfaces/CustomProduct"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"name",id:"name",level:3},{value:"qty",id:"qty",level:3},{value:"thumbnailId",id:"thumbnailid",level:3},{value:"thumbnailUrl",id:"thumbnailurl",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-cartitem",children:"Interface: CartItem"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Product ID"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Product name"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"qty",children:"qty"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"qty"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Amount of this item in the cart"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"thumbnailid",children:"thumbnailId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"thumbnailId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"thumbnailurl",children:"thumbnailUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"thumbnailUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"URL to .enc file of the thumbnail. Just change the filetype to .jpg to view the thumbnail"})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>o});var r=t(6540);const i={},c=r.createContext(i);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b35003cc.7c9aaba5.js b/assets/js/b35003cc.7c9aaba5.js new file mode 100644 index 0000000000..851ae41fee --- /dev/null +++ b/assets/js/b35003cc.7c9aaba5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1128],{6515:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(4848),c=n(8453);const o={},i="Interface: BizCategory",a={id:"reference/api/model/contact/interfaces/BizCategory",title:"Interface: BizCategory",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BizCategory.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BizCategory.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/contact",permalink:"/docs/reference/api/model/contact/"},next:{title:"Interface: BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"localized_display_name",id:"localized_display_name",level:3}];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-bizcategory",children:"Interface: BizCategory"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"localized_display_name",children:"localized_display_name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"localized_display_name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function p(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const c={},o=r.createContext(c);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b35003cc.864690e9.js b/assets/js/b35003cc.864690e9.js deleted file mode 100644 index 5a0910930c..0000000000 --- a/assets/js/b35003cc.864690e9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1128],{6515:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var r=n(4848),o=n(8453);const c={},i="Interface: BizCategory",a={id:"reference/api/model/contact/interfaces/BizCategory",title:"Interface: BizCategory",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BizCategory.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BizCategory",permalink:"/docs/reference/api/model/contact/interfaces/BizCategory",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BizCategory.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/contact",permalink:"/docs/reference/api/model/contact/"},next:{title:"Interface: BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"localized_display_name",id:"localized_display_name",level:3}];function l(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-bizcategory",children:"Interface: BizCategory"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"localized_display_name",children:"localized_display_name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"localized_display_name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const o={},c=r.createContext(o);function i(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b430c9d2.99d9e928.js b/assets/js/b430c9d2.99d9e928.js new file mode 100644 index 0000000000..09750c0501 --- /dev/null +++ b/assets/js/b430c9d2.99d9e928.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9486],{7054:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>l});var o=r(4848),s=r(8453);const i={},c="Enumeration: CLOUD_PROVIDERS",t={id:"reference/api/model/config/enumerations/CLOUD_PROVIDERS",title:"Enumeration: CLOUD\\_PROVIDERS",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/CLOUD_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/config",permalink:"/docs/reference/api/model/config/"},next:{title:"Enumeration: DIRECTORY\\_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AWS",id:"aws",level:3},{value:"CONTABO",id:"contabo",level:3},{value:"DO",id:"do",level:3},{value:"GCP",id:"gcp",level:3},{value:"MINIO",id:"minio",level:3},{value:"WASABI",id:"wasabi",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"enumeration-cloud_providers",children:"Enumeration: CLOUD_PROVIDERS"})}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"aws",children:"AWS"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AWS"}),": ",(0,o.jsx)(n.code,{children:'"AWS"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"contabo",children:"CONTABO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"CONTABO"}),": ",(0,o.jsx)(n.code,{children:'"CONTABO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"do",children:"DO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"DO"}),": ",(0,o.jsx)(n.code,{children:'"DO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"gcp",children:"GCP"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"GCP"}),": ",(0,o.jsx)(n.code,{children:'"GCP"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"minio",children:"MINIO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MINIO"}),": ",(0,o.jsx)(n.code,{children:'"MINIO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"wasabi",children:"WASABI"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"WASABI"}),": ",(0,o.jsx)(n.code,{children:'"WASABI"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b430c9d2.c6d3564f.js b/assets/js/b430c9d2.c6d3564f.js deleted file mode 100644 index 9f50807ae1..0000000000 --- a/assets/js/b430c9d2.c6d3564f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9486],{7054:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>l});var o=r(4848),s=r(8453);const i={},c="Enumeration: CLOUD_PROVIDERS",t={id:"reference/api/model/config/enumerations/CLOUD_PROVIDERS",title:"Enumeration: CLOUD\\_PROVIDERS",description:"Enumeration Members",source:"@site/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/CLOUD_PROVIDERS",permalink:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/config",permalink:"/docs/reference/api/model/config/"},next:{title:"Enumeration: DIRECTORY\\_STRATEGY",permalink:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AWS",id:"aws",level:3},{value:"CONTABO",id:"contabo",level:3},{value:"DO",id:"do",level:3},{value:"GCP",id:"gcp",level:3},{value:"MINIO",id:"minio",level:3},{value:"WASABI",id:"wasabi",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"enumeration-cloud_providers",children:"Enumeration: CLOUD_PROVIDERS"}),"\n",(0,o.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,o.jsx)(n.h3,{id:"aws",children:"AWS"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"AWS"}),": ",(0,o.jsx)(n.code,{children:'"AWS"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"contabo",children:"CONTABO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"CONTABO"}),": ",(0,o.jsx)(n.code,{children:'"CONTABO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"do",children:"DO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"DO"}),": ",(0,o.jsx)(n.code,{children:'"DO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"gcp",children:"GCP"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"GCP"}),": ",(0,o.jsx)(n.code,{children:'"GCP"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"minio",children:"MINIO"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MINIO"}),": ",(0,o.jsx)(n.code,{children:'"MINIO"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"wasabi",children:"WASABI"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"WASABI"}),": ",(0,o.jsx)(n.code,{children:'"WASABI"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b4b23ab8.f3f3a66f.js b/assets/js/b4b23ab8.f5f08a1b.js similarity index 51% rename from assets/js/b4b23ab8.f3f3a66f.js rename to assets/js/b4b23ab8.f5f08a1b.js index 13a7b110f1..b9feb7a089 100644 --- a/assets/js/b4b23ab8.f3f3a66f.js +++ b/assets/js/b4b23ab8.f5f08a1b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7347],{429:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var s=t(4848),a=t(8453);const o={},n="Type Alias: GroupChatServer",i={id:"reference/api/model/aliases/type-aliases/GroupChatServer",title:"Type Alias: GroupChatServer",description:'GroupChatServer: "g.us"',source:"@site/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId"},next:{title:"Type Alias: GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId"}},c={},p=[];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"type-alias-groupchatserver",children:"Type Alias: GroupChatServer"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"GroupChatServer"}),": ",(0,s.jsx)(r.code,{children:'"g.us"'})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"The suffix used to identify a group chat id"})]})}function u(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>n,x:()=>i});var s=t(6540);const a={},o=s.createContext(a);function n(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7347],{429:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>n,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var s=t(4848),a=t(8453);const o={},n="Type Alias: GroupChatServer",i={id:"reference/api/model/aliases/type-aliases/GroupChatServer",title:"Type Alias: GroupChatServer",description:'GroupChatServer: "g.us"',source:"@site/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId"},next:{title:"Type Alias: GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId"}},c={},p=[];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"type-alias-groupchatserver",children:"Type Alias: GroupChatServer"})}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"GroupChatServer"}),": ",(0,s.jsx)(r.code,{children:'"g.us"'})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"The suffix used to identify a group chat id"})]})}function d(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>n,x:()=>i});var s=t(6540);const a={},o=s.createContext(a);function n(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b7596626.827e88f9.js b/assets/js/b7596626.827e88f9.js new file mode 100644 index 0000000000..59823a102e --- /dev/null +++ b/assets/js/b7596626.827e88f9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8860],{9787:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>h});var o=s(4848),r=s(8453);const d={},c="Interface: BusinessHours",i={id:"reference/api/model/contact/interfaces/BusinessHours",title:"Interface: BusinessHours",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BusinessHours.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BusinessHours.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions"},next:{title:"Interface: BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile"}},l={},h=[{value:"Properties",id:"properties",level:2},{value:"config",id:"config",level:3},{value:"fri",id:"fri",level:4},{value:"fri.hours",id:"frihours",level:4},{value:"fri.mode",id:"frimode",level:4},{value:"mon",id:"mon",level:4},{value:"mon.hours",id:"monhours",level:4},{value:"mon.mode",id:"monmode",level:4},{value:"sat",id:"sat",level:4},{value:"sat.hours",id:"sathours",level:4},{value:"sat.mode",id:"satmode",level:4},{value:"sun",id:"sun",level:4},{value:"sun.hours",id:"sunhours",level:4},{value:"sun.mode",id:"sunmode",level:4},{value:"thu",id:"thu",level:4},{value:"thu.hours",id:"thuhours",level:4},{value:"thu.mode",id:"thumode",level:4},{value:"tue",id:"tue",level:4},{value:"tue.hours",id:"tuehours",level:4},{value:"tue.mode",id:"tuemode",level:4},{value:"wed",id:"wed",level:4},{value:"wed.hours",id:"wedhours",level:4},{value:"wed.mode",id:"wedmode",level:4},{value:"timezone",id:"timezone",level:3}];function t(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"interface-businesshours",children:"Interface: BusinessHours"})}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"config"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"fri",children:"fri"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"fri"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"frihours",children:"fri.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"frimode",children:"fri.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"mon",children:"mon"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mon"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"monhours",children:"mon.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"monmode",children:"mon.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sat",children:"sat"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"sat"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sathours",children:"sat.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"satmode",children:"sat.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sun",children:"sun"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"sun"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sunhours",children:"sun.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sunmode",children:"sun.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thu",children:"thu"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"thu"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thuhours",children:"thu.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thumode",children:"thu.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tue",children:"tue"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"tue"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tuehours",children:"tue.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tuemode",children:"tue.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wed",children:"wed"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"wed"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wedhours",children:"wed.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wedmode",children:"wed.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"timezone",children:"timezone"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"timezone"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(t,{...e})}):t(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>i});var o=s(6540);const r={},d=o.createContext(r);function c(e){const n=o.useContext(d);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b7596626.e97eaa70.js b/assets/js/b7596626.e97eaa70.js deleted file mode 100644 index 353ae2d25e..0000000000 --- a/assets/js/b7596626.e97eaa70.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8860],{9787:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>h});var o=s(4848),r=s(8453);const c={},d="Interface: BusinessHours",i={id:"reference/api/model/contact/interfaces/BusinessHours",title:"Interface: BusinessHours",description:"Properties",source:"@site/docs/reference/api/model/contact/interfaces/BusinessHours.md",sourceDirName:"reference/api/model/contact/interfaces",slug:"/reference/api/model/contact/interfaces/BusinessHours",permalink:"/docs/reference/api/model/contact/interfaces/BusinessHours",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/contact/interfaces/BusinessHours.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: BizProfileOptions",permalink:"/docs/reference/api/model/contact/interfaces/BizProfileOptions"},next:{title:"Interface: BusinessProfile",permalink:"/docs/reference/api/model/contact/interfaces/BusinessProfile"}},l={},h=[{value:"Properties",id:"properties",level:2},{value:"config",id:"config",level:3},{value:"fri",id:"fri",level:4},{value:"fri.hours",id:"frihours",level:4},{value:"fri.mode",id:"frimode",level:4},{value:"mon",id:"mon",level:4},{value:"mon.hours",id:"monhours",level:4},{value:"mon.mode",id:"monmode",level:4},{value:"sat",id:"sat",level:4},{value:"sat.hours",id:"sathours",level:4},{value:"sat.mode",id:"satmode",level:4},{value:"sun",id:"sun",level:4},{value:"sun.hours",id:"sunhours",level:4},{value:"sun.mode",id:"sunmode",level:4},{value:"thu",id:"thu",level:4},{value:"thu.hours",id:"thuhours",level:4},{value:"thu.mode",id:"thumode",level:4},{value:"tue",id:"tue",level:4},{value:"tue.hours",id:"tuehours",level:4},{value:"tue.mode",id:"tuemode",level:4},{value:"wed",id:"wed",level:4},{value:"wed.hours",id:"wedhours",level:4},{value:"wed.mode",id:"wedmode",level:4},{value:"timezone",id:"timezone",level:3}];function t(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-businesshours",children:"Interface: BusinessHours"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"config"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"fri",children:"fri"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"fri"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"frihours",children:"fri.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"frimode",children:"fri.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"mon",children:"mon"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mon"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"monhours",children:"mon.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"monmode",children:"mon.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sat",children:"sat"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"sat"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sathours",children:"sat.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"satmode",children:"sat.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sun",children:"sun"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"sun"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sunhours",children:"sun.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"sunmode",children:"sun.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thu",children:"thu"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"thu"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thuhours",children:"thu.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"thumode",children:"thu.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tue",children:"tue"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"tue"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tuehours",children:"tue.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"tuemode",children:"tue.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wed",children:"wed"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"wed"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wedhours",children:"wed.hours"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"hours"}),": ",(0,o.jsx)(n.code,{children:"number"}),"[][]"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"wedmode",children:"wed.mode"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"mode"}),": ",(0,o.jsx)(n.code,{children:'"specific_hours"'})," | ",(0,o.jsx)(n.code,{children:'"open_24h"'})," | ",(0,o.jsx)(n.code,{children:'"appointment_only"'})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"timezone",children:"timezone"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"timezone"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(t,{...e})}):t(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>i});var o=s(6540);const r={},c=o.createContext(r);function d(e){const n=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b764c1e9.28d05eeb.js b/assets/js/b764c1e9.28d05eeb.js deleted file mode 100644 index 3b9d826310..0000000000 --- a/assets/js/b764c1e9.28d05eeb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3370],{9635:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>d});var o=t(4848),r=t(8453);const n={},a="Variable: defaultProcessOptions",i={id:"reference/api/model/media/variables/defaultProcessOptions",title:"Variable: defaultProcessOptions",description:"const defaultProcessOptions: Mp4StickerConversionProcessOptions",source:"@site/docs/reference/api/model/media/variables/defaultProcessOptions.md",sourceDirName:"reference/api/model/media/variables",slug:"/reference/api/model/media/variables/defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/variables/defaultProcessOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata"},next:{title:"api/model/message",permalink:"/docs/reference/api/model/message/"}},c={},d=[];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"variable-defaultprocessoptions",children:"Variable: defaultProcessOptions"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.code,{children:"const"})," ",(0,o.jsx)(s.strong,{children:"defaultProcessOptions"}),": ",(0,o.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,o.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})]}),"\n"]})]})}function p(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>i});var o=t(6540);const r={},n=o.createContext(r);function a(e){const s=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),o.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b764c1e9.bdb80b5b.js b/assets/js/b764c1e9.bdb80b5b.js new file mode 100644 index 0000000000..bc859b02c6 --- /dev/null +++ b/assets/js/b764c1e9.bdb80b5b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3370],{9635:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>d});var r=t(4848),o=t(8453);const n={},a="Variable: defaultProcessOptions",i={id:"reference/api/model/media/variables/defaultProcessOptions",title:"Variable: defaultProcessOptions",description:"const defaultProcessOptions: Mp4StickerConversionProcessOptions",source:"@site/docs/reference/api/model/media/variables/defaultProcessOptions.md",sourceDirName:"reference/api/model/media/variables",slug:"/reference/api/model/media/variables/defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/media/variables/defaultProcessOptions.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: StickerMetadata",permalink:"/docs/reference/api/model/media/type-aliases/StickerMetadata"},next:{title:"api/model/message",permalink:"/docs/reference/api/model/message/"}},c={},d=[];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"variable-defaultprocessoptions",children:"Variable: defaultProcessOptions"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"const"})," ",(0,r.jsx)(s.strong,{children:"defaultProcessOptions"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,r.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})]}),"\n"]})]})}function p(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>i});var r=t(6540);const o={},n=r.createContext(o);function a(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b868a84c.6de28be0.js b/assets/js/b868a84c.6de28be0.js new file mode 100644 index 0000000000..347226e1ec --- /dev/null +++ b/assets/js/b868a84c.6de28be0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[143],{8245:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var s=n(4848),d=n(8453);const c={},i="Class: AddParticipantError",t={id:"reference/api/model/errors/classes/AddParticipantError",title:"Class: AddParticipantError",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/AddParticipantError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/AddParticipantError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/errors",permalink:"/docs/reference/api/model/errors/"},next:{title:"Class: CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError"}},l={},a=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new AddParticipantError()",id:"new-addparticipanterror",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"data",id:"data",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function o(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"class-addparticipanterror",children:"Class: AddParticipantError"})}),"\n",(0,s.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(r.h3,{id:"new-addparticipanterror",children:"new AddParticipantError()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"new AddParticipantError"}),"(",(0,s.jsx)(r.code,{children:"message"}),", ",(0,s.jsx)(r.code,{children:"data"}),"?): ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:(0,s.jsx)(r.code,{children:"AddParticipantError"})})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"data?"})]}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:(0,s.jsx)(r.code,{children:"AddParticipantError"})})}),"\n",(0,s.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"cause"}),": ",(0,s.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"data"}),": ",(0,s.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(r.p,{children:["[",(0,s.jsx)(r.code,{children:"contactId"}),": ",(0,s.jsx)(r.code,{children:"string"}),"]: ",(0,s.jsx)(r.code,{children:"number"})]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.message"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"name"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.name"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"stack"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,s.jsx)(r.code,{children:"err"}),", ",(0,s.jsx)(r.code,{children:"stackTraces"}),") => ",(0,s.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,s.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"err"}),": ",(0,s.jsx)(r.code,{children:"Error"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"stackTraces"}),": ",(0,s.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,s.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,s.jsx)(r.code,{children:"targetObject"}),", ",(0,s.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,s.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"targetObject"}),": ",(0,s.jsx)(r.code,{children:"object"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,s.jsx)(r.code,{children:"Function"})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,d.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>t});var s=n(6540);const d={},c=s.createContext(d);function i(e){const r=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:i(e.components),s.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b868a84c.eae4d5e8.js b/assets/js/b868a84c.eae4d5e8.js deleted file mode 100644 index c45c4ebbd2..0000000000 --- a/assets/js/b868a84c.eae4d5e8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[143],{8245:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var s=n(4848),d=n(8453);const c={},i="Class: AddParticipantError",t={id:"reference/api/model/errors/classes/AddParticipantError",title:"Class: AddParticipantError",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/AddParticipantError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/AddParticipantError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/errors",permalink:"/docs/reference/api/model/errors/"},next:{title:"Class: CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError"}},l={},a=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new AddParticipantError()",id:"new-addparticipanterror",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"data",id:"data",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function o(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"class-addparticipanterror",children:"Class: AddParticipantError"}),"\n",(0,s.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(r.h3,{id:"new-addparticipanterror",children:"new AddParticipantError()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"new AddParticipantError"}),"(",(0,s.jsx)(r.code,{children:"message"}),", ",(0,s.jsx)(r.code,{children:"data"}),"?): ",(0,s.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:(0,s.jsx)(r.code,{children:"AddParticipantError"})})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"data?"})]}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:(0,s.jsx)(r.code,{children:"AddParticipantError"})})}),"\n",(0,s.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"cause"}),": ",(0,s.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"data"}),": ",(0,s.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(r.p,{children:["[",(0,s.jsx)(r.code,{children:"contactId"}),": ",(0,s.jsx)(r.code,{children:"string"}),"]: ",(0,s.jsx)(r.code,{children:"number"})]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"message"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.message"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"name"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.name"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"stack"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,s.jsx)(r.code,{children:"err"}),", ",(0,s.jsx)(r.code,{children:"stackTraces"}),") => ",(0,s.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,s.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"err"}),": ",(0,s.jsx)(r.code,{children:"Error"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"stackTraces"}),": ",(0,s.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,s.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"static"})," ",(0,s.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,s.jsx)(r.code,{children:"targetObject"}),", ",(0,s.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,s.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"targetObject"}),": ",(0,s.jsx)(r.code,{children:"object"})]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,s.jsx)(r.code,{children:"Function"})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,d.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>t});var s=n(6540);const d={},c=s.createContext(d);function i(e){const r=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:i(e.components),s.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8787afe.2392845d.js b/assets/js/b8787afe.2392845d.js new file mode 100644 index 0000000000..c30404cc9f --- /dev/null +++ b/assets/js/b8787afe.2392845d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[523],{8809:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>c});var n=s(4848),o=s(8453);const t={title:"Get started with wa-automate via Docker",sidebar_label:"Easy API",sidebar_position:0,description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence."},r="Zero Install EASY API",i={id:"get-started/quick-run",title:"Get started with wa-automate via Docker",description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.",source:"@site/docs/get-started/quick-run.md",sourceDirName:"get-started",slug:"/get-started/quick-run",permalink:"/docs/get-started/quick-run",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/quick-run.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{title:"Get started with wa-automate via Docker",sidebar_label:"Easy API",sidebar_position:0,description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence."},sidebar:"tutorialSidebar",previous:{title:"How does this work?",permalink:"/docs/concepts/how-it-works"},next:{title:"Docker",permalink:"/docs/get-started/docker"}},l={},c=[{value:"Restarting session",id:"restarting-session",level:2},{value:"Running on a server",id:"running-on-a-server",level:2},{value:"Webhooks",id:"webhooks",level:2},{value:"API Docs",id:"api-docs",level:2},{value:"Postman collection",id:"postman-collection",level:2},{value:"Coming soon",id:"coming-soon",level:2}];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.header,{children:(0,n.jsx)(a.h1,{id:"zero-install-easy-api",children:"Zero Install EASY API"})}),"\n",(0,n.jsx)(a.p,{children:"Ever wanted to create an API out of your WA number? You're in luck!"}),"\n",(0,n.jsx)(a.p,{children:"Open the terminal, and enter this:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate\n"})}),"\n",(0,n.jsxs)(a.blockquote,{children:["\n",(0,n.jsxs)(a.p,{children:["P.S you have to make sure you have ",(0,n.jsx)(a.code,{children:"node"}),", ",(0,n.jsx)(a.code,{children:"npm"}),", and ",(0,n.jsx)(a.code,{children:"npx"})," installed on your system."]}),"\n"]}),"\n",(0,n.jsx)(a.p,{children:"When you run the code, it will also give you a URL to an API explorer where you can play around with the various API endpoints with documentation."}),"\n",(0,n.jsx)(a.p,{children:"You can see all the help text like so:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate --help\n"})}),"\n",(0,n.jsx)(a.p,{children:"You can set a custom port:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080\n"})}),"\n",(0,n.jsx)(a.p,{children:"and an api key which will prevent unauthorized requests. This will result in a key being automatically generated for you:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k\n"})}),"\n",(0,n.jsxs)(a.p,{children:["or you can set your own, I got the following secure key from ",(0,n.jsx)(a.a,{href:"https://randomkeygen.com/",children:"https://randomkeygen.com/"}),":"]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy'\n"})}),"\n",(0,n.jsxs)(a.p,{children:["You can easily force the program to maintain focus (",(0,n.jsx)(a.code,{children:"--keep-alive"})," or ",(0,n.jsx)(a.code,{children:"-a"}),"):"]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive\n\n//or\n\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive\n"})}),"\n",(0,n.jsx)(a.h2,{id:"restarting-session",children:"Restarting session"}),"\n",(0,n.jsxs)(a.p,{children:["As of version 2.0.0 of this library, you can now provide session data as a base64 string. This is the default method goin forward and your ",(0,n.jsx)(a.code,{children:".data.json"})," files should have this string if you've run the program in version 2.0.0+."]}),"\n",(0,n.jsxs)(a.p,{children:["There are 3 param tags that can be used to set session data ",(0,n.jsx)(a.code,{children:"-s"}),", ",(0,n.jsx)(a.code,{children:"--session"})," or ",(0,n.jsx)(a.code,{children:"--session-data"})," - all work but make sure you wrap the string with double quotes ",(0,n.jsx)(a.code,{children:'"'})," and NOT sinle quotes ",(0,n.jsx)(a.code,{children:"'"}),"."]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session-data \"eyJXQUJyb...ifQ==\"\n//or\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session \"eyJXQUJyb...ifQ==\"\n//or\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' -s \"eyJXQUJyb...ifQ==\"\n"})}),"\n",(0,n.jsx)(a.h2,{id:"running-on-a-server",children:"Running on a server"}),"\n",(0,n.jsx)(a.p,{children:"If you're not running this on your localhost, you'll need to set the server hostname for the api-docs to work correctly."}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 --api-host 'https://my-wa-api.dev:8080'\n"})}),"\n",(0,n.jsx)(a.h2,{id:"webhooks",children:"Webhooks"}),"\n",(0,n.jsxs)(a.p,{children:["You can also set a webhook address to send all requests to. I like using ",(0,n.jsx)(a.a,{href:"https://webhook.site/",children:"webhook.site"})," to check and test events."]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a'\n"})}),"\n",(0,n.jsx)(a.p,{children:"Now if you go to:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-http",children:"https://webhook.site/#!/7a00ac21-60f2-411e-a571-515b37b2025a\n"})}),"\n",(0,n.jsx)(a.p,{children:"you'll be able to see all the events come through."}),"\n",(0,n.jsx)(a.p,{children:"If you do use this link please make sure to clear all of your requests for your privacy."}),"\n",(0,n.jsx)(a.h2,{id:"api-docs",children:"API Docs"}),"\n",(0,n.jsxs)(a.p,{children:["By default, the CLI generates and serves a swagger api explorer at ",(0,n.jsx)(a.code,{children:"[host]/api-docs/"})]}),"\n",(0,n.jsx)(a.p,{children:"For example:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a' -p 8008\n"})}),"\n",(0,n.jsx)(a.p,{children:"will server the api docs at"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-http",children:"http://localhost:8008/api-docs/\n"})}),"\n",(0,n.jsx)(a.h2,{id:"postman-collection",children:"Postman collection"}),"\n",(0,n.jsx)(a.p,{children:"The CLI will also automatically generate a postman collection for your specific set up (including api keys, hostname, ports, etc.) which you can then easily import into postman."}),"\n",(0,n.jsx)(a.h2,{id:"coming-soon",children:"Coming soon"}),"\n",(0,n.jsxs)(a.p,{children:["Soon SDKs for most programming lanugages will be created using the CLI as a base 'server'. Check this issue for updates: ",(0,n.jsx)(a.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/894",children:"#894"})]})]})}function h(e={}){const{wrapper:a}={...(0,o.R)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,a,s)=>{s.d(a,{R:()=>r,x:()=>i});var n=s(6540);const o={},t=n.createContext(o);function r(e){const a=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),n.createElement(t.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8787afe.dfdab6e3.js b/assets/js/b8787afe.dfdab6e3.js deleted file mode 100644 index d2e054d621..0000000000 --- a/assets/js/b8787afe.dfdab6e3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[523],{8809:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>c});var n=s(4848),o=s(8453);const t={title:"Get started with wa-automate via Docker",sidebar_label:"Easy API",sidebar_position:0,description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence."},r="Zero Install EASY API",i={id:"get-started/quick-run",title:"Get started with wa-automate via Docker",description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.",source:"@site/docs/get-started/quick-run.md",sourceDirName:"get-started",slug:"/get-started/quick-run",permalink:"/docs/get-started/quick-run",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/quick-run.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{title:"Get started with wa-automate via Docker",sidebar_label:"Easy API",sidebar_position:0,description:"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence."},sidebar:"tutorialSidebar",previous:{title:"How does this work?",permalink:"/docs/concepts/how-it-works"},next:{title:"Docker",permalink:"/docs/get-started/docker"}},l={},c=[{value:"Restarting session",id:"restarting-session",level:2},{value:"Running on a server",id:"running-on-a-server",level:2},{value:"Webhooks",id:"webhooks",level:2},{value:"API Docs",id:"api-docs",level:2},{value:"Postman collection",id:"postman-collection",level:2},{value:"Coming soon",id:"coming-soon",level:2}];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.h1,{id:"zero-install-easy-api",children:"Zero Install EASY API"}),"\n",(0,n.jsx)(a.p,{children:"Ever wanted to create an API out of your WA number? You're in luck!"}),"\n",(0,n.jsx)(a.p,{children:"Open the terminal, and enter this:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate\n"})}),"\n",(0,n.jsxs)(a.blockquote,{children:["\n",(0,n.jsxs)(a.p,{children:["P.S you have to make sure you have ",(0,n.jsx)(a.code,{children:"node"}),", ",(0,n.jsx)(a.code,{children:"npm"}),", and ",(0,n.jsx)(a.code,{children:"npx"})," installed on your system."]}),"\n"]}),"\n",(0,n.jsx)(a.p,{children:"When you run the code, it will also give you a URL to an API explorer where you can play around with the various API endpoints with documentation."}),"\n",(0,n.jsx)(a.p,{children:"You can see all the help text like so:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate --help\n"})}),"\n",(0,n.jsx)(a.p,{children:"You can set a custom port:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080\n"})}),"\n",(0,n.jsx)(a.p,{children:"and an api key which will prevent unauthorized requests. This will result in a key being automatically generated for you:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k\n"})}),"\n",(0,n.jsxs)(a.p,{children:["or you can set your own, I got the following secure key from ",(0,n.jsx)(a.a,{href:"https://randomkeygen.com/",children:"https://randomkeygen.com/"}),":"]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy'\n"})}),"\n",(0,n.jsxs)(a.p,{children:["You can easily force the program to maintain focus (",(0,n.jsx)(a.code,{children:"--keep-alive"})," or ",(0,n.jsx)(a.code,{children:"-a"}),"):"]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive\n\n//or\n\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive\n"})}),"\n",(0,n.jsx)(a.h2,{id:"restarting-session",children:"Restarting session"}),"\n",(0,n.jsxs)(a.p,{children:["As of version 2.0.0 of this library, you can now provide session data as a base64 string. This is the default method goin forward and your ",(0,n.jsx)(a.code,{children:".data.json"})," files should have this string if you've run the program in version 2.0.0+."]}),"\n",(0,n.jsxs)(a.p,{children:["There are 3 param tags that can be used to set session data ",(0,n.jsx)(a.code,{children:"-s"}),", ",(0,n.jsx)(a.code,{children:"--session"})," or ",(0,n.jsx)(a.code,{children:"--session-data"})," - all work but make sure you wrap the string with double quotes ",(0,n.jsx)(a.code,{children:'"'})," and NOT sinle quotes ",(0,n.jsx)(a.code,{children:"'"}),"."]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session-data \"eyJXQUJyb...ifQ==\"\n//or\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session \"eyJXQUJyb...ifQ==\"\n//or\n> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' -s \"eyJXQUJyb...ifQ==\"\n"})}),"\n",(0,n.jsx)(a.h2,{id:"running-on-a-server",children:"Running on a server"}),"\n",(0,n.jsx)(a.p,{children:"If you're not running this on your localhost, you'll need to set the server hostname for the api-docs to work correctly."}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -p 8080 --api-host 'https://my-wa-api.dev:8080'\n"})}),"\n",(0,n.jsx)(a.h2,{id:"webhooks",children:"Webhooks"}),"\n",(0,n.jsxs)(a.p,{children:["You can also set a webhook address to send all requests to. I like using ",(0,n.jsx)(a.a,{href:"https://webhook.site/",children:"webhook.site"})," to check and test events."]}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a'\n"})}),"\n",(0,n.jsx)(a.p,{children:"Now if you go to:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-http",children:"https://webhook.site/#!/7a00ac21-60f2-411e-a571-515b37b2025a\n"})}),"\n",(0,n.jsx)(a.p,{children:"you'll be able to see all the events come through."}),"\n",(0,n.jsx)(a.p,{children:"If you do use this link please make sure to clear all of your requests for your privacy."}),"\n",(0,n.jsx)(a.h2,{id:"api-docs",children:"API Docs"}),"\n",(0,n.jsxs)(a.p,{children:["By default, the CLI generates and serves a swagger api explorer at ",(0,n.jsx)(a.code,{children:"[host]/api-docs/"})]}),"\n",(0,n.jsx)(a.p,{children:"For example:"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-bash",children:"> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a' -p 8008\n"})}),"\n",(0,n.jsx)(a.p,{children:"will server the api docs at"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-http",children:"http://localhost:8008/api-docs/\n"})}),"\n",(0,n.jsx)(a.h2,{id:"postman-collection",children:"Postman collection"}),"\n",(0,n.jsx)(a.p,{children:"The CLI will also automatically generate a postman collection for your specific set up (including api keys, hostname, ports, etc.) which you can then easily import into postman."}),"\n",(0,n.jsx)(a.h2,{id:"coming-soon",children:"Coming soon"}),"\n",(0,n.jsxs)(a.p,{children:["Soon SDKs for most programming lanugages will be created using the CLI as a base 'server'. Check this issue for updates: ",(0,n.jsx)(a.a,{href:"https://github.com/open-wa/wa-automate-nodejs/issues/894",children:"#894"})]})]})}function h(e={}){const{wrapper:a}={...(0,o.R)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,a,s)=>{s.d(a,{R:()=>r,x:()=>i});var n=s(6540);const o={},t=n.createContext(o);function r(e){const a=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),n.createElement(t.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8b00aea.5b7a8743.js b/assets/js/b8b00aea.5b7a8743.js deleted file mode 100644 index 0b72f3a458..0000000000 --- a/assets/js/b8b00aea.5b7a8743.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4212],{8326:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var s=r(4848),t=r(8453);const i={},c="Interface: EventPayload",d={id:"reference/api/model/config/interfaces/EventPayload",title:"Interface: EventPayload",description:"Indexable",source:"@site/docs/reference/api/model/config/interfaces/EventPayload.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/EventPayload.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools"},next:{title:"Interface: ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials"}},o={},l=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"event",id:"event",level:3},{value:"id",id:"id",level:3},{value:"sessionId",id:"sessionid",level:3},{value:"ts",id:"ts",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-eventpayload",children:"Interface: EventPayload"}),"\n",(0,s.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"k"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"event",children:"event"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"event"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,s.jsx)(n.code,{children:"SimpleListener"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sessionid",children:"sessionId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ts",children:"ts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ts"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>d});var s=r(6540);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8b00aea.a4e761ec.js b/assets/js/b8b00aea.a4e761ec.js new file mode 100644 index 0000000000..41164b6399 --- /dev/null +++ b/assets/js/b8b00aea.a4e761ec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1831],{8326:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=r(4848),t=r(8453);const i={},d="Interface: EventPayload",c={id:"reference/api/model/config/interfaces/EventPayload",title:"Interface: EventPayload",description:"Indexable",source:"@site/docs/reference/api/model/config/interfaces/EventPayload.md",sourceDirName:"reference/api/model/config/interfaces",slug:"/reference/api/model/config/interfaces/EventPayload",permalink:"/docs/reference/api/model/config/interfaces/EventPayload",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/interfaces/EventPayload.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DevTools",permalink:"/docs/reference/api/model/config/interfaces/DevTools"},next:{title:"Interface: ProxyServerCredentials",permalink:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials"}},o={},l=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"event",id:"event",level:3},{value:"id",id:"id",level:3},{value:"sessionId",id:"sessionid",level:3},{value:"ts",id:"ts",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-eventpayload",children:"Interface: EventPayload"})}),"\n",(0,s.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"k"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"data",children:"data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"event",children:"event"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"event"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,s.jsx)(n.code,{children:"SimpleListener"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sessionid",children:"sessionId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sessionId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ts",children:"ts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ts"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var s=r(6540);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b998fb11.61639bbe.js b/assets/js/b998fb11.61639bbe.js new file mode 100644 index 0000000000..388b2b679f --- /dev/null +++ b/assets/js/b998fb11.61639bbe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2193],{4209:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var n=t(4848),s=t(8453);const o={},c="Interface: DialogState",i={id:"reference/structures/Dialog/interfaces/DialogState",title:"Interface: DialogState",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogState.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty"},next:{title:"Interface: DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"currentProps",id:"currentprops",level:3},{value:"currentStep",id:"currentstep",level:3},{value:"errorMessage",id:"errormessage",level:3},{value:"isComplete",id:"iscomplete",level:3},{value:"isError",id:"iserror",level:3},{value:"lastInput",id:"lastinput",level:3}];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-dialogstate",children:"Interface: DialogState"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"currentprops",children:"currentProps"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"currentProps"}),": ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"currentstep",children:"currentStep"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"currentStep"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"errormessage",children:"errorMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"errorMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"iscomplete",children:"isComplete"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"isComplete"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"iserror",children:"isError"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"isError"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"lastinput",children:"lastInput"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"lastInput"}),": ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>i});var n=t(6540);const s={},o=n.createContext(s);function c(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b998fb11.d88e074f.js b/assets/js/b998fb11.d88e074f.js deleted file mode 100644 index f07df102c2..0000000000 --- a/assets/js/b998fb11.d88e074f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2193],{4209:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var n=t(4848),s=t(8453);const o={},c="Interface: DialogState",i={id:"reference/structures/Dialog/interfaces/DialogState",title:"Interface: DialogState",description:"Properties",source:"@site/docs/reference/structures/Dialog/interfaces/DialogState.md",sourceDirName:"reference/structures/Dialog/interfaces",slug:"/reference/structures/Dialog/interfaces/DialogState",permalink:"/docs/reference/structures/Dialog/interfaces/DialogState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/interfaces/DialogState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: DialogProperty",permalink:"/docs/reference/structures/Dialog/interfaces/DialogProperty"},next:{title:"Interface: DialogTemplate",permalink:"/docs/reference/structures/Dialog/interfaces/DialogTemplate"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"currentProps",id:"currentprops",level:3},{value:"currentStep",id:"currentstep",level:3},{value:"errorMessage",id:"errormessage",level:3},{value:"isComplete",id:"iscomplete",level:3},{value:"isError",id:"iserror",level:3},{value:"lastInput",id:"lastinput",level:3}];function d(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-dialogstate",children:"Interface: DialogState"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"currentprops",children:"currentProps"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"currentProps"}),": ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"currentstep",children:"currentStep"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"currentStep"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"errormessage",children:"errorMessage"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"errorMessage"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"iscomplete",children:"isComplete"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"isComplete"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"iserror",children:"isError"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"isError"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"lastinput",children:"lastInput"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"lastInput"}),": ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>i});var n=t(6540);const s={},o=n.createContext(s);function c(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bb20bb94.d9831f34.js b/assets/js/bb20bb94.d9831f34.js new file mode 100644 index 0000000000..8561f806a4 --- /dev/null +++ b/assets/js/bb20bb94.d9831f34.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70],{8804:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=t(4848),r=t(8453);const i={},o="api/functions/exposed.enum",c={id:"reference/api/functions/exposed.enum/index",title:"api/functions/exposed.enum",description:"Index",source:"@site/docs/reference/api/functions/exposed.enum/index.md",sourceDirName:"reference/api/functions/exposed.enum",slug:"/reference/api/functions/exposed.enum/",permalink:"/docs/reference/api/functions/exposed.enum/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/functions/exposed.enum/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: useragent",permalink:"/docs/reference/api/Client/variables/useragent"},next:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"}},u={},a=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"apifunctionsexposedenum",children:"api/functions/exposed.enum"})}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",children:"ExposedFn"})}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var s=t(6540);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bb20bb94.fa9b75e9.js b/assets/js/bb20bb94.fa9b75e9.js deleted file mode 100644 index 74ac5a9285..0000000000 --- a/assets/js/bb20bb94.fa9b75e9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70],{8804:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=t(4848),o=t(8453);const i={},r="api/functions/exposed.enum",c={id:"reference/api/functions/exposed.enum/index",title:"api/functions/exposed.enum",description:"Index",source:"@site/docs/reference/api/functions/exposed.enum/index.md",sourceDirName:"reference/api/functions/exposed.enum",slug:"/reference/api/functions/exposed.enum/",permalink:"/docs/reference/api/functions/exposed.enum/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/functions/exposed.enum/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: useragent",permalink:"/docs/reference/api/Client/variables/useragent"},next:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"}},u={},a=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"apifunctionsexposedenum",children:"api/functions/exposed.enum"}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",children:"ExposedFn"})}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(6540);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bc6fb640.0a03c761.js b/assets/js/bc6fb640.0a03c761.js new file mode 100644 index 0000000000..359dd6a0ee --- /dev/null +++ b/assets/js/bc6fb640.0a03c761.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6854],{1484:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>d,contentTitle:()=>t,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=s(4848),o=s(8453);const i={},t="api/model/errors",a={id:"reference/api/model/errors/index",title:"api/model/errors",description:"Index",source:"@site/docs/reference/api/model/errors/index.md",sourceDirName:"reference/api/model/errors",slug:"/reference/api/model/errors/",permalink:"/docs/reference/api/model/errors/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: Status",permalink:"/docs/reference/api/model/enumerations/Status"},next:{title:"Class: AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError"}},d={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodelerrors",children:"api/model/errors"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"classes",children:"Classes"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>t,x:()=>a});var n=s(6540);const o={},i=n.createContext(o);function t(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bc6fb640.bfafcaba.js b/assets/js/bc6fb640.bfafcaba.js deleted file mode 100644 index 333d7d1022..0000000000 --- a/assets/js/bc6fb640.bfafcaba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6854],{1484:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>d,contentTitle:()=>t,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=s(4848),o=s(8453);const i={},t="api/model/errors",a={id:"reference/api/model/errors/index",title:"api/model/errors",description:"Index",source:"@site/docs/reference/api/model/errors/index.md",sourceDirName:"reference/api/model/errors",slug:"/reference/api/model/errors/",permalink:"/docs/reference/api/model/errors/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: Status",permalink:"/docs/reference/api/model/enumerations/Status"},next:{title:"Class: AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError"}},d={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"apimodelerrors",children:"api/model/errors"}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"classes",children:"Classes"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>t,x:()=>a});var n=s(6540);const o={},i=n.createContext(o);function t(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd5628fe.3bd29085.js b/assets/js/bd5628fe.3bd29085.js deleted file mode 100644 index aa2e230892..0000000000 --- a/assets/js/bd5628fe.3bd29085.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6909],{6713:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>u});var r=t(4848),c=t(8453);const n={},o="structures/MessageCollector",l={id:"reference/structures/MessageCollector/index",title:"structures/MessageCollector",description:"Index",source:"@site/docs/reference/structures/MessageCollector/index.md",sourceDirName:"reference/structures/MessageCollector",slug:"/reference/structures/MessageCollector/",permalink:"/docs/reference/structures/MessageCollector/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/MessageCollector/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CheckFunction()",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction"},next:{title:"Class: MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector"}},a={},u=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3}];function i(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"structuresmessagecollector",children:"structures/MessageCollector"}),"\n",(0,r.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(s.h3,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:"MessageCollector"})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(i,{...e})}):i(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>o,x:()=>l});var r=t(6540);const c={},n=r.createContext(c);function o(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd5628fe.8f7aafe3.js b/assets/js/bd5628fe.8f7aafe3.js new file mode 100644 index 0000000000..38cd2721d1 --- /dev/null +++ b/assets/js/bd5628fe.8f7aafe3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6909],{6713:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>u});var t=r(4848),c=r(8453);const n={},o="structures/MessageCollector",l={id:"reference/structures/MessageCollector/index",title:"structures/MessageCollector",description:"Index",source:"@site/docs/reference/structures/MessageCollector/index.md",sourceDirName:"reference/structures/MessageCollector",slug:"/reference/structures/MessageCollector/",permalink:"/docs/reference/structures/MessageCollector/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/MessageCollector/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: CheckFunction()",permalink:"/docs/reference/structures/Dialog/type-aliases/CheckFunction"},next:{title:"Class: MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector"}},a={},u=[{value:"Index",id:"index",level:2},{value:"Classes",id:"classes",level:3}];function i(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"structuresmessagecollector",children:"structures/MessageCollector"})}),"\n",(0,t.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,t.jsx)(s.h3,{id:"classes",children:"Classes"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:"MessageCollector"})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>o,x:()=>l});var t=r(6540);const c={},n=t.createContext(c);function o(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/be8c3764.54ae17b0.js b/assets/js/be8c3764.54ae17b0.js deleted file mode 100644 index 66b1d6ba5c..0000000000 --- a/assets/js/be8c3764.54ae17b0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6611],{3170:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var n=r(4848),o=r(8453);const t={},c="Enumeration: PREPROCESSORS",i={id:"reference/structures/preProcessors/enumerations/PREPROCESSORS",title:"Enumeration: PREPROCESSORS",description:"A set of easy to use, built-in message processors.",source:"@site/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",sourceDirName:"reference/structures/preProcessors/enumerations",slug:"/reference/structures/preProcessors/enumerations/PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/preProcessors",permalink:"/docs/reference/structures/preProcessors/"},next:{title:"Type Alias: MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTO_DECRYPT",id:"auto_decrypt",level:3},{value:"AUTO_DECRYPT_SAVE",id:"auto_decrypt_save",level:3},{value:"BODY_ONLY",id:"body_only",level:3},{value:"SCRUB",id:"scrub",level:3},{value:"UPLOAD_CLOUD",id:"upload_cloud",level:3}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"enumeration-preprocessors",children:"Enumeration: PREPROCESSORS"}),"\n",(0,n.jsx)(s.p,{children:"A set of easy to use, built-in message processors."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts",children:"Check out the processor code here"})}),"\n",(0,n.jsx)(s.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,n.jsx)(s.h3,{id:"auto_decrypt",children:"AUTO_DECRYPT"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"AUTO_DECRYPT"}),": ",(0,n.jsx)(s.code,{children:'"AUTO_DECRYPT"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["Replaces the media thumbnail base64 in ",(0,n.jsx)(s.code,{children:"body"})," with the actual file's DataURL."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"auto_decrypt_save",children:"AUTO_DECRYPT_SAVE"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"AUTO_DECRYPT_SAVE"}),": ",(0,n.jsx)(s.code,{children:'"AUTO_DECRYPT_SAVE"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["Automatically saves the file in a folder named ",(0,n.jsx)(s.code,{children:"/media"})," relative to the process working directory."]}),"\n",(0,n.jsx)(s.p,{children:"PLEASE NOTE, YOU WILL NEED TO MANUALLY CLEAR THIS FOLDER!!!"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"body_only",children:"BODY_ONLY"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"BODY_ONLY"}),": ",(0,n.jsx)(s.code,{children:'"BODY_ONLY"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["A preprocessor that limits the amount of base64 data is present in the message object by removing duplication of ",(0,n.jsx)(s.code,{children:"body"})," in ",(0,n.jsx)(s.code,{children:"content"})," by replacing ",(0,n.jsx)(s.code,{children:"content"})," with ",(0,n.jsx)(s.code,{children:'""'}),"."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"scrub",children:"SCRUB"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"SCRUB"}),": ",(0,n.jsx)(s.code,{children:'"SCRUB"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["This preprocessor scrubs ",(0,n.jsx)(s.code,{children:"body"})," and ",(0,n.jsx)(s.code,{children:"content"})," from media messages.\nThis would be useful if you want to reduce the message object size because neither of these values represent the actual file, only the thumbnail."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"upload_cloud",children:"UPLOAD_CLOUD"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"UPLOAD_CLOUD"}),": ",(0,n.jsx)(s.code,{children:'"UPLOAD_CLOUD"'})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Uploads file to a cloud storage provider (GCP/AWS for now)."}),"\n",(0,n.jsxs)(s.p,{children:["If this preprocessor is set then you have to also set ",(0,n.jsx)(s.a,{href:"https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions",children:(0,n.jsx)(s.code,{children:"cloudUploadOptions"})})," in the config."]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>c,x:()=>i});var n=r(6540);const o={},t=n.createContext(o);function c(e){const s=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),n.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/be8c3764.a5fb93a7.js b/assets/js/be8c3764.a5fb93a7.js new file mode 100644 index 0000000000..5a78ef3203 --- /dev/null +++ b/assets/js/be8c3764.a5fb93a7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6611],{3170:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var n=r(4848),o=r(8453);const t={},c="Enumeration: PREPROCESSORS",i={id:"reference/structures/preProcessors/enumerations/PREPROCESSORS",title:"Enumeration: PREPROCESSORS",description:"A set of easy to use, built-in message processors.",source:"@site/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",sourceDirName:"reference/structures/preProcessors/enumerations",slug:"/reference/structures/preProcessors/enumerations/PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/preProcessors",permalink:"/docs/reference/structures/preProcessors/"},next:{title:"Type Alias: MPConfigType",permalink:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"AUTO_DECRYPT",id:"auto_decrypt",level:3},{value:"AUTO_DECRYPT_SAVE",id:"auto_decrypt_save",level:3},{value:"BODY_ONLY",id:"body_only",level:3},{value:"SCRUB",id:"scrub",level:3},{value:"UPLOAD_CLOUD",id:"upload_cloud",level:3}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"enumeration-preprocessors",children:"Enumeration: PREPROCESSORS"})}),"\n",(0,n.jsx)(s.p,{children:"A set of easy to use, built-in message processors."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts",children:"Check out the processor code here"})}),"\n",(0,n.jsx)(s.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,n.jsx)(s.h3,{id:"auto_decrypt",children:"AUTO_DECRYPT"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"AUTO_DECRYPT"}),": ",(0,n.jsx)(s.code,{children:'"AUTO_DECRYPT"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["Replaces the media thumbnail base64 in ",(0,n.jsx)(s.code,{children:"body"})," with the actual file's DataURL."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"auto_decrypt_save",children:"AUTO_DECRYPT_SAVE"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"AUTO_DECRYPT_SAVE"}),": ",(0,n.jsx)(s.code,{children:'"AUTO_DECRYPT_SAVE"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["Automatically saves the file in a folder named ",(0,n.jsx)(s.code,{children:"/media"})," relative to the process working directory."]}),"\n",(0,n.jsx)(s.p,{children:"PLEASE NOTE, YOU WILL NEED TO MANUALLY CLEAR THIS FOLDER!!!"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"body_only",children:"BODY_ONLY"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"BODY_ONLY"}),": ",(0,n.jsx)(s.code,{children:'"BODY_ONLY"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["A preprocessor that limits the amount of base64 data is present in the message object by removing duplication of ",(0,n.jsx)(s.code,{children:"body"})," in ",(0,n.jsx)(s.code,{children:"content"})," by replacing ",(0,n.jsx)(s.code,{children:"content"})," with ",(0,n.jsx)(s.code,{children:'""'}),"."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"scrub",children:"SCRUB"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"SCRUB"}),": ",(0,n.jsx)(s.code,{children:'"SCRUB"'})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["This preprocessor scrubs ",(0,n.jsx)(s.code,{children:"body"})," and ",(0,n.jsx)(s.code,{children:"content"})," from media messages.\nThis would be useful if you want to reduce the message object size because neither of these values represent the actual file, only the thumbnail."]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"upload_cloud",children:"UPLOAD_CLOUD"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"UPLOAD_CLOUD"}),": ",(0,n.jsx)(s.code,{children:'"UPLOAD_CLOUD"'})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Uploads file to a cloud storage provider (GCP/AWS for now)."}),"\n",(0,n.jsxs)(s.p,{children:["If this preprocessor is set then you have to also set ",(0,n.jsx)(s.a,{href:"https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions",children:(0,n.jsx)(s.code,{children:"cloudUploadOptions"})})," in the config."]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>c,x:()=>i});var n=r(6540);const o={},t=n.createContext(o);function c(e){const s=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),n.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1aedf5a.e363ee7d.js b/assets/js/c1aedf5a.e363ee7d.js new file mode 100644 index 0000000000..c046b53207 --- /dev/null +++ b/assets/js/c1aedf5a.e363ee7d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9745],{1701:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=s(4848),c=s(8453);const i={},t="Type Alias: ReactionRecord",o={id:"reference/api/model/reactions/type-aliases/ReactionRecord",title:"Type Alias: ReactionRecord",description:"ReactionRecord: object",source:"@site/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent"},next:{title:"api/model/sessionInfo",permalink:"/docs/reference/api/model/sessionInfo/"}},d={},a=[{value:"Type declaration",id:"type-declaration",level:2},{value:"ack",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"type-alias-reactionrecord",children:"Type Alias: ReactionRecord"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ReactionRecord"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The specific reaction by a user"}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:(0,r.jsx)(n.code,{children:"MessageAck"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The acknowledgement of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction has been read"}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the reaction sender"}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>o});var r=s(6540);const c={},i=r.createContext(c);function t(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1aedf5a.fd707699.js b/assets/js/c1aedf5a.fd707699.js deleted file mode 100644 index 063b9b5f89..0000000000 --- a/assets/js/c1aedf5a.fd707699.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9745],{1701:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=s(4848),c=s(8453);const i={},t="Type Alias: ReactionRecord",o={id:"reference/api/model/reactions/type-aliases/ReactionRecord",title:"Type Alias: ReactionRecord",description:"ReactionRecord: object",source:"@site/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent"},next:{title:"api/model/sessionInfo",permalink:"/docs/reference/api/model/sessionInfo/"}},d={},a=[{value:"Type declaration",id:"type-declaration",level:2},{value:"ack",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-reactionrecord",children:"Type Alias: ReactionRecord"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ReactionRecord"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The specific reaction by a user"}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:(0,r.jsx)(n.code,{children:"MessageAck"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The acknowledgement of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction has been read"}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the reaction sender"}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>o});var r=s(6540);const c={},i=r.createContext(c);function t(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1f86f2f.5c9ccd87.js b/assets/js/c1f86f2f.5c9ccd87.js deleted file mode 100644 index 0fe5578814..0000000000 --- a/assets/js/c1f86f2f.5c9ccd87.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9761],{222:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>L,contentTitle:()=>N,default:()=>B,frontMatter:()=>E,metadata:()=>C,toc:()=>S});var s=t(4848),r=t(8453),i=t(6540),o=t(4164),a=t(3104),l=t(6347),c=t(205),u=t(7485),h=t(1682),d=t(679);function m(e){return i.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,i.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,i.useMemo)((()=>{const e=n??function(e){return m(e).map((e=>{let{props:{value:n,label:t,attributes:s,default:r}}=e;return{value:n,label:t,attributes:s,default:r}}))}(t);return function(e){const n=(0,h.X)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function f(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function y(e){let{queryString:n=!1,groupId:t}=e;const s=(0,l.W6)(),r=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,u.aZ)(r),(0,i.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(s.location.search);n.set(r,e),s.replace({...s.location,search:n.toString()})}),[r,s])]}function b(e){const{defaultValue:n,queryString:t=!1,groupId:s}=e,r=p(e),[o,a]=(0,i.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!f({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const s=t.find((e=>e.default))??t[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:n,tabValues:r}))),[l,u]=y({queryString:t,groupId:s}),[h,m]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[s,r]=(0,d.Dv)(t);return[s,(0,i.useCallback)((e=>{t&&r.set(e)}),[t,r])]}({groupId:s}),b=(()=>{const e=l??h;return f({value:e,tabValues:r})?e:null})();(0,c.A)((()=>{b&&a(b)}),[b]);return{selectedValue:o,selectValue:(0,i.useCallback)((e=>{if(!f({value:e,tabValues:r}))throw new Error(`Can't select invalid tab value=${e}`);a(e),u(e),m(e)}),[u,m,r]),tabValues:r}}var x=t(2303);const j={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function g(e){let{className:n,block:t,selectedValue:r,selectValue:i,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:u}=(0,a.a_)(),h=e=>{const n=e.currentTarget,t=c.indexOf(n),s=l[t].value;s!==r&&(u(n),i(s))},d=e=>{let n=null;switch(e.key){case"Enter":h(e);break;case"ArrowRight":{const t=c.indexOf(e.currentTarget)+1;n=c[t]??c[0];break}case"ArrowLeft":{const t=c.indexOf(e.currentTarget)-1;n=c[t]??c[c.length-1];break}}n?.focus()};return(0,s.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,o.A)("tabs",{"tabs--block":t},n),children:l.map((e=>{let{value:n,label:t,attributes:i}=e;return(0,s.jsx)("li",{role:"tab",tabIndex:r===n?0:-1,"aria-selected":r===n,ref:e=>c.push(e),onKeyDown:d,onClick:h,...i,className:(0,o.A)("tabs__item",j.tabItem,i?.className,{"tabs__item--active":r===n}),children:t??n},n)}))})}function v(e){let{lazy:n,children:t,selectedValue:r}=e;const o=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=o.find((e=>e.props.value===r));return e?(0,i.cloneElement)(e,{className:"margin-top--md"}):null}return(0,s.jsx)("div",{className:"margin-top--md",children:o.map(((e,n)=>(0,i.cloneElement)(e,{key:n,hidden:e.props.value!==r})))})}function w(e){const n=b(e);return(0,s.jsxs)("div",{className:(0,o.A)("tabs-container",j.tabList),children:[(0,s.jsx)(g,{...n,...e}),(0,s.jsx)(v,{...n,...e})]})}function k(e){const n=(0,x.A)();return(0,s.jsx)(w,{...e,children:m(e.children)},String(n))}const A={tabItem:"tabItem_Ymn6"};function I(e){let{children:n,hidden:t,className:r}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,o.A)(A.tabItem,r),hidden:t,children:n})}const E={},N="Licensed Features",C={id:"configuration/licensed-features",title:"Licensed Features",description:"Features",source:"@site/docs/configuration/licensed-features.mdx",sourceDirName:"configuration",slug:"/configuration/licensed-features",permalink:"/docs/configuration/licensed-features",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/licensed-features.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Launch Events",permalink:"/docs/configuration/launch-events"},next:{title:"Multiple Sessions",permalink:"/docs/configuration/multiple-sessions"}},L={},S=[{value:"Features",id:"features",level:2},{value:"Insiders Features",id:"insiders-features",level:3},{value:"Sending messages to non-contact numbers",id:"sending-messages-to-non-contact-numbers",level:3},{value:"Story Keys",id:"story-keys",level:3},{value:"How to get a License Key",id:"how-to-get-a-license-key",level:2},{value:"How to use your license",id:"how-to-use-your-license",level:2},{value:"Keys",id:"keys",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"Switching your host account",id:"switching-your-host-account",level:2},{value:"Notes",id:"notes",level:2}];function T(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"licensed-features",children:"Licensed Features"}),"\n",(0,s.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,s.jsx)(n.h3,{id:"insiders-features",children:"Insiders Features"}),"\n",(0,s.jsxs)(n.p,{children:['open-wa is at the forefront of open source WA development. Some cutting edge features are available exclusively to license holders. Although there are multiple types of licenses, the most affordable is the Insiders license with the most amount of unlockable features. To identify which features are unlcoked with an Insiders license, look out for the "Insiders" tag in ',(0,s.jsx)(n.a,{href:"/docs/api/classes/api_Client.Client",children:"the Client documentation"}),"."]}),"\n",(0,s.jsx)("img",{src:"/img/license-identifier.png"}),"\n",(0,s.jsx)(n.h3,{id:"sending-messages-to-non-contact-numbers",children:"Sending messages to non-contact numbers"}),"\n",(0,s.jsx)(n.p,{children:"The ability to send messages to non-contact numbers is restricted in this library to prevent spam."}),"\n",(0,s.jsx)(n.p,{children:"There are 3 ways to start a chat with a new number:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://faq.whatsapp.com/en/26000030/",children:"WA Links"})}),"\n",(0,s.jsx)(n.p,{children:"You can send a special link to the person you want to start a chat with. This will open a conversation with your number on their phone. This way you can insure that they have explicitly started a conversation with you."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/smashah/whatsapp-button?ref=open-wa-nodejs",children:"WA Buttons"})}),"\n",(0,s.jsx)(n.p,{children:"You can add this button to your website which, when clicked, will open a chat with you in the same way as above."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"#how-to-get-a-license-key",children:"With a Restricted License Key"})}),"\n",(0,s.jsxs)(n.p,{children:["In order to unlock the functionality to send texts to unknown numbers through @open-wa/wa-automate itself, you will need a ",(0,s.jsx)(n.a,{href:"https://gum.co/open-wa?tier=1%20Restricted%20License%20Key",children:"Restricted License key"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["One License Key is valid for one number. Each License Key for this is \xa310 per month. ",(0,s.jsx)(n.a,{href:"#how-to-get-a-license-key",children:"Instructions below."})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"story-keys",children:"Story Keys"}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsx)(n.p,{children:"Unfortunately, due to MD updates story features are currently broken."})}),"\n",(0,s.jsxs)(n.p,{children:["After a lot of effort, ability to send text, image and video stories is available exclusively in this library. If you want access to the feature of posting Whatsapp Stories, please contact ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev",children:"shah@openwa.dev"})]}),"\n",(0,s.jsx)(n.h2,{id:"how-to-get-a-license-key",children:"How to get a License Key"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Go to ",(0,s.jsx)(n.a,{href:"https://gum.co/BTMt?tier=1%20Restricted%20License%20Key",children:"Gumroad"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Click on the type of license you require."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["In the checkout, ",(0,s.jsx)(n.em,{children:(0,s.jsx)(n.strong,{children:"enter the host account number you want to assign to the License Key (the one you will be using with open-wa, not your personal number)"})})," , along with the use case for this functionality and your github username. Please note, with this new system you'll only be able to change the number once."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Complete the checkout process."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You will instantly receive your License key on the screen and in your email."}),"\n",(0,s.jsx)("div",{align:"center",children:(0,s.jsx)("img",{src:"https://raw.githubusercontent.com/open-wa/wa-automate-nodejs/master/resources/membership.png"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Use your license with the instructions below:"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"how-to-use-your-license",children:"How to use your license"}),"\n",(0,s.jsxs)(n.p,{children:["This depends on how you're using the library. If you're using it with your own custom code then you can enter the licenseKey like so within the config of your ",(0,s.jsx)(n.code,{children:"create"})," command:"]}),"\n","\n",(0,s.jsxs)(k,{groupId:"usage-mode",defaultValue:"cli",values:[{label:"EASY API",value:"cli"},{label:"Code",value:"code"},{label:"Docker",value:"docker"}],children:[(0,s.jsx)(I,{value:"cli",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"> npx @open-wa/wa-automate --license-key FE764A87-BB9B48EE-BBBC035C-9736F87\n"})})}),(0,s.jsx)(I,{value:"code",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'create({\n licenseKey: "FE764A87-BB9B48EE-BBBC035C-9736F87"\n})\n'})})}),(0,s.jsx)(I,{value:"docker",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"> docker run openwa/wa-automate --license-key FE764A87-BB9B48EE-BBBC035C-9736F87\n"})})})]}),"\n",(0,s.jsx)(n.h2,{id:"keys",children:"Keys"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Name"}),(0,s.jsx)(n.th,{children:"link"}),(0,s.jsx)(n.th,{children:"Description"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Insiders"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://gum.co/BTMt?tier=Insiders%20Program",children:"LINK"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.a,{href:"#insiders-features",children:"All Insiders Features"}),"#insiders-features"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Restricted"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://gum.co/open-wa?tier=1%20Restricted%20License%20Key",children:"LINK"})}),(0,s.jsx)(n.td,{children:"Send messages to non-contacts"})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"All keys include access to all insider's features. You do not need a Premium Key to send messages to non-contacts."}),"\n",(0,s.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsx)(n.p,{children:"If the license key is showing up as invalid, there may be an issue with your host account number you entered in the checkout form. In some countries, the host account number is different from the actual number (for example in Brazil, an extra 9 is added). If you're unsure about your host account number then use the following code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"const hostAccountNumber = await client.getHostNumber();\nconsole.log('Host account', hostAccountNumber);\n"})}),"\n",(0,s.jsxs)(n.p,{children:["If it's different from what you've entered in the checkout form, ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%20WRONG%20HOST%20ACC%20NUMBER&body=email%20used%20to%20buy%20key%3A%0D%0Alicense%20key%3A%0D%0Acorrect%20host%20account%20number%3A%0D%0A",children:"please fill and send this email."})]}),"\n",(0,s.jsxs)(n.p,{children:["If you are having issues where your license key shows as valid in the console, but the features continually return ",(0,s.jsx)(n.code,{children:"false"})," this may be due to a NodeJS issue relating to the time on your machine. To fix this, make sure your machine's time is correct."]}),"\n",(0,s.jsx)(n.h2,{id:"switching-your-host-account",children:"Switching your host account"}),"\n",(0,s.jsxs)(n.p,{children:["If your development and production host accounts are different, then you can enter the development host account number in the form and when you're ready to your production host account, ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%PRODUCTION%20HOST%20ACC%20NUMBER&body=email%20used%20to%20buy%20key%3A%0D%0Alicense%20key%3A%0D%0Acorrect%20host%20account%20number%3A%0D%0A",children:"fill and send this email."})]}),"\n",(0,s.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"One license key is valid for one host account number."}),"\n",(0,s.jsx)(n.li,{children:"You can change the number assigned to a specific License Key once."}),"\n",(0,s.jsx)(n.li,{children:"In order to cancel your License Key, simply stop your membership."}),"\n",(0,s.jsx)(n.li,{children:"You can use multiple license keys for each host number."}),"\n",(0,s.jsx)(n.li,{children:"Apart from adding your licenseKey to your config, you will need to change nothing else in your code."}),"\n",(0,s.jsx)(n.li,{children:"An added benefit for members is priority on issues."}),"\n",(0,s.jsx)(n.li,{children:"License Key requests may be rejected."}),"\n",(0,s.jsx)(n.li,{children:"All code you will receive from the license server is closed-sourced and is under the same license as this project. You will not be able to read it. It is not transferrable to another number or another project."}),"\n",(0,s.jsx)(n.li,{children:"All keys provide access to Insiders Features."}),"\n",(0,s.jsxs)(n.li,{children:["No Refunds unless you have chosen the incorrect license upon checkout. Refund requests need to take place after the correct license is purchased. ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%LICENSE%3A%CORRECTION",children:"Once the correct license is purchased please email me for a refund."})]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%VOLUME%25%20LICENSE",children:"Volume licenses are available upon request."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%Referral%25%20Scheme",children:"Referral links are available upon request."})}),"\n"]})]})}function B(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1f86f2f.9f85142a.js b/assets/js/c1f86f2f.9f85142a.js new file mode 100644 index 0000000000..d865f364c7 --- /dev/null +++ b/assets/js/c1f86f2f.9f85142a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9761],{222:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>L,contentTitle:()=>N,default:()=>B,frontMatter:()=>E,metadata:()=>C,toc:()=>S});var s=t(4848),r=t(8453),i=t(6540),o=t(4164),a=t(3104),l=t(6347),c=t(205),u=t(7485),h=t(1682),d=t(679);function m(e){return i.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,i.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,i.useMemo)((()=>{const e=n??function(e){return m(e).map((e=>{let{props:{value:n,label:t,attributes:s,default:r}}=e;return{value:n,label:t,attributes:s,default:r}}))}(t);return function(e){const n=(0,h.XI)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function f(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function y(e){let{queryString:n=!1,groupId:t}=e;const s=(0,l.W6)(),r=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,u.aZ)(r),(0,i.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(s.location.search);n.set(r,e),s.replace({...s.location,search:n.toString()})}),[r,s])]}function b(e){const{defaultValue:n,queryString:t=!1,groupId:s}=e,r=p(e),[o,a]=(0,i.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!f({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const s=t.find((e=>e.default))??t[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:n,tabValues:r}))),[l,u]=y({queryString:t,groupId:s}),[h,m]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[s,r]=(0,d.Dv)(t);return[s,(0,i.useCallback)((e=>{t&&r.set(e)}),[t,r])]}({groupId:s}),b=(()=>{const e=l??h;return f({value:e,tabValues:r})?e:null})();(0,c.A)((()=>{b&&a(b)}),[b]);return{selectedValue:o,selectValue:(0,i.useCallback)((e=>{if(!f({value:e,tabValues:r}))throw new Error(`Can't select invalid tab value=${e}`);a(e),u(e),m(e)}),[u,m,r]),tabValues:r}}var x=t(2303);const j={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function g(e){let{className:n,block:t,selectedValue:r,selectValue:i,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:u}=(0,a.a_)(),h=e=>{const n=e.currentTarget,t=c.indexOf(n),s=l[t].value;s!==r&&(u(n),i(s))},d=e=>{let n=null;switch(e.key){case"Enter":h(e);break;case"ArrowRight":{const t=c.indexOf(e.currentTarget)+1;n=c[t]??c[0];break}case"ArrowLeft":{const t=c.indexOf(e.currentTarget)-1;n=c[t]??c[c.length-1];break}}n?.focus()};return(0,s.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,o.A)("tabs",{"tabs--block":t},n),children:l.map((e=>{let{value:n,label:t,attributes:i}=e;return(0,s.jsx)("li",{role:"tab",tabIndex:r===n?0:-1,"aria-selected":r===n,ref:e=>c.push(e),onKeyDown:d,onClick:h,...i,className:(0,o.A)("tabs__item",j.tabItem,i?.className,{"tabs__item--active":r===n}),children:t??n},n)}))})}function v(e){let{lazy:n,children:t,selectedValue:r}=e;const a=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=a.find((e=>e.props.value===r));return e?(0,i.cloneElement)(e,{className:(0,o.A)("margin-top--md",e.props.className)}):null}return(0,s.jsx)("div",{className:"margin-top--md",children:a.map(((e,n)=>(0,i.cloneElement)(e,{key:n,hidden:e.props.value!==r})))})}function w(e){const n=b(e);return(0,s.jsxs)("div",{className:(0,o.A)("tabs-container",j.tabList),children:[(0,s.jsx)(g,{...n,...e}),(0,s.jsx)(v,{...n,...e})]})}function k(e){const n=(0,x.A)();return(0,s.jsx)(w,{...e,children:m(e.children)},String(n))}const A={tabItem:"tabItem_Ymn6"};function I(e){let{children:n,hidden:t,className:r}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,o.A)(A.tabItem,r),hidden:t,children:n})}const E={},N="Licensed Features",C={id:"configuration/licensed-features",title:"Licensed Features",description:"Features",source:"@site/docs/configuration/licensed-features.mdx",sourceDirName:"configuration",slug:"/configuration/licensed-features",permalink:"/docs/configuration/licensed-features",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/configuration/licensed-features.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Launch Events",permalink:"/docs/configuration/launch-events"},next:{title:"Multiple Sessions",permalink:"/docs/configuration/multiple-sessions"}},L={},S=[{value:"Features",id:"features",level:2},{value:"Insiders Features",id:"insiders-features",level:3},{value:"Sending messages to non-contact numbers",id:"sending-messages-to-non-contact-numbers",level:3},{value:"Story Keys",id:"story-keys",level:3},{value:"How to get a License Key",id:"how-to-get-a-license-key",level:2},{value:"How to use your license",id:"how-to-use-your-license",level:2},{value:"Keys",id:"keys",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"Switching your host account",id:"switching-your-host-account",level:2},{value:"Notes",id:"notes",level:2}];function T(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"licensed-features",children:"Licensed Features"})}),"\n",(0,s.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,s.jsx)(n.h3,{id:"insiders-features",children:"Insiders Features"}),"\n",(0,s.jsxs)(n.p,{children:['open-wa is at the forefront of open source WA development. Some cutting edge features are available exclusively to license holders. Although there are multiple types of licenses, the most affordable is the Insiders license with the most amount of unlockable features. To identify which features are unlcoked with an Insiders license, look out for the "Insiders" tag in ',(0,s.jsx)(n.a,{href:"/docs/api/classes/api_Client.Client",children:"the Client documentation"}),"."]}),"\n",(0,s.jsx)("img",{src:"/img/license-identifier.png"}),"\n",(0,s.jsx)(n.h3,{id:"sending-messages-to-non-contact-numbers",children:"Sending messages to non-contact numbers"}),"\n",(0,s.jsx)(n.p,{children:"The ability to send messages to non-contact numbers is restricted in this library to prevent spam."}),"\n",(0,s.jsx)(n.p,{children:"There are 3 ways to start a chat with a new number:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://faq.whatsapp.com/en/26000030/",children:"WA Links"})}),"\n",(0,s.jsx)(n.p,{children:"You can send a special link to the person you want to start a chat with. This will open a conversation with your number on their phone. This way you can insure that they have explicitly started a conversation with you."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/smashah/whatsapp-button?ref=open-wa-nodejs",children:"WA Buttons"})}),"\n",(0,s.jsx)(n.p,{children:"You can add this button to your website which, when clicked, will open a chat with you in the same way as above."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"#how-to-get-a-license-key",children:"With a Restricted License Key"})}),"\n",(0,s.jsxs)(n.p,{children:["In order to unlock the functionality to send texts to unknown numbers through @open-wa/wa-automate itself, you will need a ",(0,s.jsx)(n.a,{href:"https://gum.co/open-wa?tier=1%20Restricted%20License%20Key",children:"Restricted License key"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["One License Key is valid for one number. Each License Key for this is \xa310 per month. ",(0,s.jsx)(n.a,{href:"#how-to-get-a-license-key",children:"Instructions below."})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"story-keys",children:"Story Keys"}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsx)(n.p,{children:"Unfortunately, due to MD updates story features are currently broken."})}),"\n",(0,s.jsxs)(n.p,{children:["After a lot of effort, ability to send text, image and video stories is available exclusively in this library. If you want access to the feature of posting Whatsapp Stories, please contact ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev",children:"shah@openwa.dev"})]}),"\n",(0,s.jsx)(n.h2,{id:"how-to-get-a-license-key",children:"How to get a License Key"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Go to ",(0,s.jsx)(n.a,{href:"https://gum.co/BTMt?tier=1%20Restricted%20License%20Key",children:"Gumroad"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Click on the type of license you require."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["In the checkout, ",(0,s.jsx)(n.em,{children:(0,s.jsx)(n.strong,{children:"enter the host account number you want to assign to the License Key (the one you will be using with open-wa, not your personal number)"})})," , along with the use case for this functionality and your github username. Please note, with this new system you'll only be able to change the number once."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Complete the checkout process."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You will instantly receive your License key on the screen and in your email."}),"\n",(0,s.jsx)("div",{align:"center",children:(0,s.jsx)("img",{src:"https://raw.githubusercontent.com/open-wa/wa-automate-nodejs/master/resources/membership.png"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Use your license with the instructions below:"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"how-to-use-your-license",children:"How to use your license"}),"\n",(0,s.jsxs)(n.p,{children:["This depends on how you're using the library. If you're using it with your own custom code then you can enter the licenseKey like so within the config of your ",(0,s.jsx)(n.code,{children:"create"})," command:"]}),"\n","\n",(0,s.jsxs)(k,{groupId:"usage-mode",defaultValue:"cli",values:[{label:"EASY API",value:"cli"},{label:"Code",value:"code"},{label:"Docker",value:"docker"}],children:[(0,s.jsx)(I,{value:"cli",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"> npx @open-wa/wa-automate --license-key FE764A87-BB9B48EE-BBBC035C-9736F87\n"})})}),(0,s.jsx)(I,{value:"code",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'create({\n licenseKey: "FE764A87-BB9B48EE-BBBC035C-9736F87"\n})\n'})})}),(0,s.jsx)(I,{value:"docker",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"> docker run openwa/wa-automate --license-key FE764A87-BB9B48EE-BBBC035C-9736F87\n"})})})]}),"\n",(0,s.jsx)(n.h2,{id:"keys",children:"Keys"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Name"}),(0,s.jsx)(n.th,{children:"link"}),(0,s.jsx)(n.th,{children:"Description"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Insiders"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://gum.co/BTMt?tier=Insiders%20Program",children:"LINK"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.a,{href:"#insiders-features",children:"All Insiders Features"}),"#insiders-features"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Restricted"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.a,{href:"https://gum.co/open-wa?tier=1%20Restricted%20License%20Key",children:"LINK"})}),(0,s.jsx)(n.td,{children:"Send messages to non-contacts"})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"All keys include access to all insider's features. You do not need a Premium Key to send messages to non-contacts."}),"\n",(0,s.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsx)(n.p,{children:"If the license key is showing up as invalid, there may be an issue with your host account number you entered in the checkout form. In some countries, the host account number is different from the actual number (for example in Brazil, an extra 9 is added). If you're unsure about your host account number then use the following code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"const hostAccountNumber = await client.getHostNumber();\nconsole.log('Host account', hostAccountNumber);\n"})}),"\n",(0,s.jsxs)(n.p,{children:["If it's different from what you've entered in the checkout form, ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%20WRONG%20HOST%20ACC%20NUMBER&body=email%20used%20to%20buy%20key%3A%0D%0Alicense%20key%3A%0D%0Acorrect%20host%20account%20number%3A%0D%0A",children:"please fill and send this email."})]}),"\n",(0,s.jsxs)(n.p,{children:["If you are having issues where your license key shows as valid in the console, but the features continually return ",(0,s.jsx)(n.code,{children:"false"})," this may be due to a NodeJS issue relating to the time on your machine. To fix this, make sure your machine's time is correct."]}),"\n",(0,s.jsx)(n.h2,{id:"switching-your-host-account",children:"Switching your host account"}),"\n",(0,s.jsxs)(n.p,{children:["If your development and production host accounts are different, then you can enter the development host account number in the form and when you're ready to your production host account, ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%PRODUCTION%20HOST%20ACC%20NUMBER&body=email%20used%20to%20buy%20key%3A%0D%0Alicense%20key%3A%0D%0Acorrect%20host%20account%20number%3A%0D%0A",children:"fill and send this email."})]}),"\n",(0,s.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"One license key is valid for one host account number."}),"\n",(0,s.jsx)(n.li,{children:"You can change the number assigned to a specific License Key once."}),"\n",(0,s.jsx)(n.li,{children:"In order to cancel your License Key, simply stop your membership."}),"\n",(0,s.jsx)(n.li,{children:"You can use multiple license keys for each host number."}),"\n",(0,s.jsx)(n.li,{children:"Apart from adding your licenseKey to your config, you will need to change nothing else in your code."}),"\n",(0,s.jsx)(n.li,{children:"An added benefit for members is priority on issues."}),"\n",(0,s.jsx)(n.li,{children:"License Key requests may be rejected."}),"\n",(0,s.jsx)(n.li,{children:"All code you will receive from the license server is closed-sourced and is under the same license as this project. You will not be able to read it. It is not transferrable to another number or another project."}),"\n",(0,s.jsx)(n.li,{children:"All keys provide access to Insiders Features."}),"\n",(0,s.jsxs)(n.li,{children:["No Refunds unless you have chosen the incorrect license upon checkout. Refund requests need to take place after the correct license is purchased. ",(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%LICENSE%3A%CORRECTION",children:"Once the correct license is purchased please email me for a refund."})]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%VOLUME%25%20LICENSE",children:"Volume licenses are available upon request."})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"mailto:shah@openwa.dev?subject=OPENWA%3A%Referral%25%20Scheme",children:"Referral links are available upon request."})}),"\n"]})]})}function B(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c26b1eba.383bac69.js b/assets/js/c26b1eba.383bac69.js deleted file mode 100644 index 77a5876cee..0000000000 --- a/assets/js/c26b1eba.383bac69.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7513],{1487:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>g,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>t,toc:()=>a});var o=i(4848),r=i(8453);const s={},l="logging/logging",t={id:"reference/logging/logging/index",title:"logging/logging",description:"Index",source:"@site/docs/reference/logging/logging/index.md",sourceDirName:"reference/logging/logging",slug:"/reference/logging/logging/",permalink:"/docs/reference/logging/logging/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport"},next:{title:"Function: addRotateFileLogTransport()",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport"}},g={},a=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3}];function c(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"logginglogging",children:"logging/logging"}),"\n",(0,o.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,o.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",children:"ConfigLogTransport"})}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/variables/log",children:"log"})}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",children:"addRotateFileLogTransport"})}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>t});var o=i(6540);const r={},s=o.createContext(r);function l(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c26b1eba.3d17a7ca.js b/assets/js/c26b1eba.3d17a7ca.js new file mode 100644 index 0000000000..f556f6a401 --- /dev/null +++ b/assets/js/c26b1eba.3d17a7ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7513],{1487:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>g,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>t,toc:()=>a});var o=i(4848),r=i(8453);const s={},l="logging/logging",t={id:"reference/logging/logging/index",title:"logging/logging",description:"Index",source:"@site/docs/reference/logging/logging/index.md",sourceDirName:"reference/logging/logging",slug:"/reference/logging/logging/",permalink:"/docs/reference/logging/logging/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport"},next:{title:"Function: addRotateFileLogTransport()",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport"}},g={},a=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3}];function c(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"logginglogging",children:"logging/logging"})}),"\n",(0,o.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,o.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",children:"ConfigLogTransport"})}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/variables/log",children:"log"})}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"functions",children:"Functions"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",children:"addRotateFileLogTransport"})}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>t});var o=i(6540);const r={},s=o.createContext(r);function l(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c37329a9.0f38a878.js b/assets/js/c37329a9.0f38a878.js deleted file mode 100644 index b7e07f2285..0000000000 --- a/assets/js/c37329a9.0f38a878.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4014],{7776:(e,s,o)=>{o.r(s),o.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>i});var n=o(4848),t=o(8453);const r={},l="Interface: PollData",c={id:"reference/api/model/message/interfaces/PollData",title:"Interface: PollData",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollData.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollData.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction"},next:{title:"Interface: PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption"}},a={},i=[{value:"Properties",id:"properties",level:2},{value:"pollMessage",id:"pollmessage",level:3},{value:"pollOptions",id:"polloptions",level:3},{value:"totalVotes",id:"totalvotes",level:3},{value:"votes",id:"votes",level:3}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"interface-polldata",children:"Interface: PollData"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"pollmessage",children:"pollMessage"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"pollMessage"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The message object of the poll"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"polloptions",children:"pollOptions"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"pollOptions"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,n.jsx)(s.code,{children:"PollOption"})})," & ",(0,n.jsx)(s.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The poll options and their respective count of votes."}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"totalvotes",children:"totalVotes"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"totalVotes"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The total amount of votes recorded so far"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"votes",children:"votes"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"votes"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:(0,n.jsx)(s.code,{children:"PollVote"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"An arrray of vote objects"})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,s,o)=>{o.d(s,{R:()=>l,x:()=>c});var n=o(6540);const t={},r=n.createContext(t);function l(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c37329a9.c36b1777.js b/assets/js/c37329a9.c36b1777.js new file mode 100644 index 0000000000..a7fab4c3c8 --- /dev/null +++ b/assets/js/c37329a9.c36b1777.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4014],{7776:(e,s,o)=>{o.r(s),o.d(s,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>i});var n=o(4848),t=o(8453);const r={},l="Interface: PollData",a={id:"reference/api/model/message/interfaces/PollData",title:"Interface: PollData",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollData.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollData.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction"},next:{title:"Interface: PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption"}},c={},i=[{value:"Properties",id:"properties",level:2},{value:"pollMessage",id:"pollmessage",level:3},{value:"pollOptions",id:"polloptions",level:3},{value:"totalVotes",id:"totalvotes",level:3},{value:"votes",id:"votes",level:3}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"interface-polldata",children:"Interface: PollData"})}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"pollmessage",children:"pollMessage"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"pollMessage"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,n.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The message object of the poll"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"polloptions",children:"pollOptions"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"pollOptions"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,n.jsx)(s.code,{children:"PollOption"})})," & ",(0,n.jsx)(s.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The poll options and their respective count of votes."}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"totalvotes",children:"totalVotes"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"totalVotes"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"The total amount of votes recorded so far"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"votes",children:"votes"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"votes"}),": ",(0,n.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:(0,n.jsx)(s.code,{children:"PollVote"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"An arrray of vote objects"})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,s,o)=>{o.d(s,{R:()=>l,x:()=>a});var n=o(6540);const t={},r=n.createContext(t);function l(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7b94894.3c6ff6fa.js b/assets/js/c7b94894.3c6ff6fa.js deleted file mode 100644 index a24e1ad0e0..0000000000 --- a/assets/js/c7b94894.3c6ff6fa.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2513],{6001:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var r=c(4848),s=c(8453);const t={},o="Function: getAndInjectLicense()",i={id:"reference/controllers/patch_manager/functions/getAndInjectLicense",title:"Function: getAndInjectLicense()",description:"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\",source:"@site/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",sourceDirName:"reference/controllers/patch_manager/functions",slug:"/reference/controllers/patch_manager/functions/getAndInjectLicense",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: earlyInjectionCheck()",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck"},next:{title:"logging/custom\\_transport",permalink:"/docs/reference/logging/custom_transport/"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-getandinjectlicense",children:"Function: getAndInjectLicense()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getAndInjectLicense"}),"(",(0,r.jsx)(n.code,{children:"page"}),", ",(0,r.jsx)(n.code,{children:"config"}),", ",(0,r.jsx)(n.code,{children:"me"}),", ",(0,r.jsx)(n.code,{children:"debugInfo"}),", ",(0,r.jsx)(n.code,{children:"spinner"}),"?, ",(0,r.jsx)(n.code,{children:"preloadedLicense"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"page"}),": ",(0,r.jsx)(n.code,{children:"Page"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"config"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(n.code,{children:"ConfigObject"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"me"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"me._serialized"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"debugInfo"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(n.code,{children:"SessionInfo"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"spinner?"}),": ",(0,r.jsx)(n.code,{children:"Spin"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"preloadedLicense?"}),": ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"false"})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>o,x:()=>i});var r=c(6540);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7b94894.fdd048b9.js b/assets/js/c7b94894.fdd048b9.js new file mode 100644 index 0000000000..deebc9c33d --- /dev/null +++ b/assets/js/c7b94894.fdd048b9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2513],{6001:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var r=c(4848),s=c(8453);const t={},o="Function: getAndInjectLicense()",i={id:"reference/controllers/patch_manager/functions/getAndInjectLicense",title:"Function: getAndInjectLicense()",description:"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\",source:"@site/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",sourceDirName:"reference/controllers/patch_manager/functions",slug:"/reference/controllers/patch_manager/functions/getAndInjectLicense",permalink:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: earlyInjectionCheck()",permalink:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck"},next:{title:"logging/custom\\_transport",permalink:"/docs/reference/logging/custom_transport/"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"function-getandinjectlicense",children:"Function: getAndInjectLicense()"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getAndInjectLicense"}),"(",(0,r.jsx)(n.code,{children:"page"}),", ",(0,r.jsx)(n.code,{children:"config"}),", ",(0,r.jsx)(n.code,{children:"me"}),", ",(0,r.jsx)(n.code,{children:"debugInfo"}),", ",(0,r.jsx)(n.code,{children:"spinner"}),"?, ",(0,r.jsx)(n.code,{children:"preloadedLicense"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"page"}),": ",(0,r.jsx)(n.code,{children:"Page"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"config"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(n.code,{children:"ConfigObject"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"me"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"me._serialized"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"debugInfo"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(n.code,{children:"SessionInfo"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"spinner?"}),": ",(0,r.jsx)(n.code,{children:"Spin"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"preloadedLicense?"}),": ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"false"})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,c)=>{c.d(n,{R:()=>o,x:()=>i});var r=c(6540);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c939f76a.1bf0bd7e.js b/assets/js/c939f76a.1bf0bd7e.js deleted file mode 100644 index 3308d38dfc..0000000000 --- a/assets/js/c939f76a.1bf0bd7e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8405],{6015:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var s=r(4848),a=r(8453);const o={},n="Type Alias: GroupChatId",i={id:"reference/api/model/aliases/type-aliases/GroupChatId",title:"Type Alias: GroupChatId",description:"GroupChatId: \\$\\{AccountNumber\\}-$\\{number\\}@$\\{GroupChatServer\\}\\ \\| GroupId",source:"@site/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL"},next:{title:"Type Alias: GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer"}},c={},d=[];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-groupchatid",children:"Type Alias: GroupChatId"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"GroupChatId"}),": `${AccountNumber}-${number}@${GroupChatServer}` | ",(0,s.jsx)(t.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:(0,s.jsx)(t.code,{children:"GroupId"})})]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["A group chat ends with ",(0,s.jsx)(t.code,{children:"@g.us"})," and usually has two parts, the timestamp of when it was created, and the user id of the number that created the group. For example ",(0,s.jsx)(t.code,{children:"[creator number]-[timestamp]@g.us"})]}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:'"447123456789-1445627445@g.us"'})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>n,x:()=>i});var s=r(6540);const a={},o=s.createContext(a);function n(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c939f76a.2572ef50.js b/assets/js/c939f76a.2572ef50.js new file mode 100644 index 0000000000..96b920f568 --- /dev/null +++ b/assets/js/c939f76a.2572ef50.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8405],{6015:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>n,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var a=t(4848),s=t(8453);const o={},n="Type Alias: GroupChatId",i={id:"reference/api/model/aliases/type-aliases/GroupChatId",title:"Type Alias: GroupChatId",description:"GroupChatId: \\$\\{AccountNumber\\}-$\\{number\\}@$\\{GroupChatServer\\}\\ \\| GroupId",source:"@site/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/GroupChatId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GetURL",permalink:"/docs/reference/api/model/aliases/type-aliases/GetURL"},next:{title:"Type Alias: GroupChatServer",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer"}},c={},d=[];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.header,{children:(0,a.jsx)(r.h1,{id:"type-alias-groupchatid",children:"Type Alias: GroupChatId"})}),"\n",(0,a.jsxs)(r.blockquote,{children:["\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.strong,{children:"GroupChatId"}),": `${AccountNumber}-${number}@${GroupChatServer}` | ",(0,a.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:(0,a.jsx)(r.code,{children:"GroupId"})})]}),"\n"]}),"\n",(0,a.jsxs)(r.p,{children:["A group chat ends with ",(0,a.jsx)(r.code,{children:"@g.us"})," and usually has two parts, the timestamp of when it was created, and the user id of the number that created the group. For example ",(0,a.jsx)(r.code,{children:"[creator number]-[timestamp]@g.us"})]}),"\n",(0,a.jsx)(r.p,{children:"Example:"}),"\n",(0,a.jsx)(r.p,{children:(0,a.jsx)(r.code,{children:'"447123456789-1445627445@g.us"'})})]})}function l(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>n,x:()=>i});var a=t(6540);const s={},o=a.createContext(s);function n(e){const r=a.useContext(o);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:n(e.components),a.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c9540765.b0d221fa.js b/assets/js/c9540765.b0d221fa.js deleted file mode 100644 index 49782c63d0..0000000000 --- a/assets/js/c9540765.b0d221fa.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2484],{4819:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(4848),o=t(8453);const a={},i="Interface: NewCommunityGroup",c={id:"reference/api/model/group-metadata/interfaces/NewCommunityGroup",title:"Interface: NewCommunityGroup",description:"Used when creating a new community with.",source:"@site/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata"},next:{title:"Interface: Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"ephemeralDuration?",id:"ephemeralduration",level:3},{value:"icon?",id:"icon",level:3},{value:"subject",id:"subject",level:3}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-newcommunitygroup",children:"Interface: NewCommunityGroup"}),"\n",(0,r.jsx)(n.p,{children:"Used when creating a new community with."}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ephemeralduration",children:"ephemeralDuration?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ephemeralDuration"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"icon"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(n.code,{children:"DataURL"})})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"subject",children:"subject"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"subject"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>c});var r=t(6540);const o={},a=r.createContext(o);function i(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c9540765.e38e5f19.js b/assets/js/c9540765.e38e5f19.js new file mode 100644 index 0000000000..1ed0f083b4 --- /dev/null +++ b/assets/js/c9540765.e38e5f19.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2484],{4819:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=r(4848),o=r(8453);const a={},i="Interface: NewCommunityGroup",c={id:"reference/api/model/group-metadata/interfaces/NewCommunityGroup",title:"Interface: NewCommunityGroup",description:"Used when creating a new community with.",source:"@site/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",sourceDirName:"reference/api/model/group-metadata/interfaces",slug:"/reference/api/model/group-metadata/interfaces/NewCommunityGroup",permalink:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupMetadata",permalink:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata"},next:{title:"Interface: Participant",permalink:"/docs/reference/api/model/group-metadata/interfaces/Participant"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"ephemeralDuration?",id:"ephemeralduration",level:3},{value:"icon?",id:"icon",level:3},{value:"subject",id:"subject",level:3}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-newcommunitygroup",children:"Interface: NewCommunityGroup"})}),"\n",(0,t.jsx)(n.p,{children:"Used when creating a new community with."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ephemeralduration",children:"ephemeralDuration?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"ephemeralDuration"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"icon"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,t.jsx)(n.code,{children:"DataURL"})})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"subject",children:"subject"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"subject"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var t=r(6540);const o={},a=t.createContext(o);function i(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb21221e.e50fd5c8.js b/assets/js/cb21221e.e50fd5c8.js new file mode 100644 index 0000000000..13fed3226e --- /dev/null +++ b/assets/js/cb21221e.e50fd5c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9969],{5017:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=t(4848),i=t(8453);const a={},c="api/model/reactions",o={id:"reference/api/model/reactions/index",title:"api/model/reactions",description:"Index",source:"@site/docs/reference/api/model/reactions/index.md",sourceDirName:"reference/api/model/reactions",slug:"/reference/api/model/reactions/",permalink:"/docs/reference/api/model/reactions/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Product",permalink:"/docs/reference/api/model/product/interfaces/Product"},next:{title:"Type Alias: Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction"}},s={},d=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelreactions",children:"api/model/reactions"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const i={},a=r.createContext(i);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb21221e.ff03ccbf.js b/assets/js/cb21221e.ff03ccbf.js deleted file mode 100644 index 90155de1c0..0000000000 --- a/assets/js/cb21221e.ff03ccbf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9969],{5017:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=t(4848),r=t(8453);const c={},o="api/model/reactions",a={id:"reference/api/model/reactions/index",title:"api/model/reactions",description:"Index",source:"@site/docs/reference/api/model/reactions/index.md",sourceDirName:"reference/api/model/reactions",slug:"/reference/api/model/reactions/",permalink:"/docs/reference/api/model/reactions/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Product",permalink:"/docs/reference/api/model/product/interfaces/Product"},next:{title:"Type Alias: Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction"}},s={},d=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"apimodelreactions",children:"api/model/reactions"}),"\n",(0,i.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(6540);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ccc49370.040d7f7d.js b/assets/js/ccc49370.040d7f7d.js deleted file mode 100644 index 2008b72dc7..0000000000 --- a/assets/js/ccc49370.040d7f7d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3249],{3858:(e,t,n)=>{n.r(t),n.d(t,{default:()=>j});n(6540);var i=n(4164),a=n(5500),o=n(7559),r=n(7131),s=n(6535),l=n(4651),c=n(1312),d=n(9022),u=n(4848);function m(e){const{nextItem:t,prevItem:n}=e;return(0,u.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,c.T)({id:"theme.blog.post.paginator.navAriaLabel",message:"Blog post page navigation",description:"The ARIA label for the blog posts pagination"}),children:[n&&(0,u.jsx)(d.A,{...n,subLabel:(0,u.jsx)(c.A,{id:"theme.blog.post.paginator.newerPost",description:"The blog post button label to navigate to the newer/previous post",children:"Newer Post"})}),t&&(0,u.jsx)(d.A,{...t,subLabel:(0,u.jsx)(c.A,{id:"theme.blog.post.paginator.olderPost",description:"The blog post button label to navigate to the older/next post",children:"Older Post"}),isNext:!0})]})}function g(){const{assets:e,metadata:t}=(0,r.e)(),{title:n,description:i,date:o,tags:s,authors:l,frontMatter:c}=t,{keywords:d}=c,m=e.image??c.image;return(0,u.jsxs)(a.be,{title:n,description:i,keywords:d,image:m,children:[(0,u.jsx)("meta",{property:"og:type",content:"article"}),(0,u.jsx)("meta",{property:"article:published_time",content:o}),l.some((e=>e.url))&&(0,u.jsx)("meta",{property:"article:author",content:l.map((e=>e.url)).filter(Boolean).join(",")}),s.length>0&&(0,u.jsx)("meta",{property:"article:tag",content:s.map((e=>e.label)).join(",")})]})}var p=n(5260),h=n(6676);function f(){const e=(0,h.J)();return(0,u.jsx)(p.A,{children:(0,u.jsx)("script",{type:"application/ld+json",children:JSON.stringify(e)})})}var v=n(7763),x=n(996);function b(e){let{sidebar:t,children:n}=e;const{metadata:i,toc:a}=(0,r.e)(),{nextItem:o,prevItem:c,frontMatter:d,unlisted:g}=i,{hide_table_of_contents:p,toc_min_heading_level:h,toc_max_heading_level:f}=d;return(0,u.jsxs)(s.A,{sidebar:t,toc:!p&&a.length>0?(0,u.jsx)(v.A,{toc:a,minHeadingLevel:h,maxHeadingLevel:f}):void 0,children:[g&&(0,u.jsx)(x.A,{}),(0,u.jsx)(l.A,{children:n}),(o||c)&&(0,u.jsx)(m,{nextItem:o,prevItem:c})]})}function j(e){const t=e.content;return(0,u.jsx)(r.i,{content:e.content,isBlogPostPage:!0,children:(0,u.jsxs)(a.e3,{className:(0,i.A)(o.G.wrapper.blogPages,o.G.page.blogPostPage),children:[(0,u.jsx)(g,{}),(0,u.jsx)(f,{}),(0,u.jsx)(b,{sidebar:e.sidebar,children:(0,u.jsx)(t,{})})]})})}},7763:(e,t,n)=>{n.d(t,{A:()=>c});n(6540);var i=n(4164),a=n(5195);const o={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var r=n(4848);const s="table-of-contents__link toc-highlight",l="table-of-contents__link--active";function c(e){let{className:t,...n}=e;return(0,r.jsx)("div",{className:(0,i.A)(o.tableOfContents,"thin-scrollbar",t),children:(0,r.jsx)(a.A,{...n,linkClassName:s,linkActiveClassName:l})})}},5195:(e,t,n)=>{n.d(t,{A:()=>h});var i=n(6540),a=n(6342);function o(e){const t=e.map((e=>({...e,parentIndex:-1,children:[]}))),n=Array(7).fill(-1);t.forEach(((e,t)=>{const i=n.slice(2,e.level);e.parentIndex=Math.max(...i),n[e.level]=t}));const i=[];return t.forEach((e=>{const{parentIndex:n,...a}=e;n>=0?t[n].children.push(a):i.push(a)})),i}function r(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:i}=e;return t.flatMap((e=>{const t=r({toc:e.children,minHeadingLevel:n,maxHeadingLevel:i});return function(e){return e.level>=n&&e.level<=i}(e)?[{...e,children:t}]:t}))}function s(e){const t=e.getBoundingClientRect();return t.top===t.bottom?s(e.parentNode):t}function l(e,t){let{anchorTopOffset:n}=t;const i=e.find((e=>s(e).top>=n));if(i){return function(e){return e.top>0&&e.bottom{e.current=t?0:document.querySelector(".navbar").clientHeight}),[t]),e}function d(e){const t=(0,i.useRef)(void 0),n=c();(0,i.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:i,linkActiveClassName:a,minHeadingLevel:o,maxHeadingLevel:r}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(i),s=function(e){let{minHeadingLevel:t,maxHeadingLevel:n}=e;const i=[];for(let a=t;a<=n;a+=1)i.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(i.join()))}({minHeadingLevel:o,maxHeadingLevel:r}),c=l(s,{anchorTopOffset:n.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,n){n?(t.current&&t.current!==e&&t.current.classList.remove(a),e.classList.add(a),t.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",s),document.addEventListener("resize",s),s(),()=>{document.removeEventListener("scroll",s),document.removeEventListener("resize",s)}}),[e,n])}var u=n(8774),m=n(4848);function g(e){let{toc:t,className:n,linkClassName:i,isChild:a}=e;return t.length?(0,m.jsx)("ul",{className:a?void 0:n,children:t.map((e=>(0,m.jsxs)("li",{children:[(0,m.jsx)(u.A,{to:`#${e.id}`,className:i??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,m.jsx)(g,{isChild:!0,toc:e.children,className:n,linkClassName:i})]},e.id)))}):null}const p=i.memo(g);function h(e){let{toc:t,className:n="table-of-contents table-of-contents__left-border",linkClassName:s="table-of-contents__link",linkActiveClassName:l,minHeadingLevel:c,maxHeadingLevel:u,...g}=e;const h=(0,a.p)(),f=c??h.tableOfContents.minHeadingLevel,v=u??h.tableOfContents.maxHeadingLevel,x=function(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:a}=e;return(0,i.useMemo)((()=>r({toc:o(t),minHeadingLevel:n,maxHeadingLevel:a})),[t,n,a])}({toc:t,minHeadingLevel:f,maxHeadingLevel:v});return d((0,i.useMemo)((()=>{if(s&&l)return{linkClassName:s,linkActiveClassName:l,minHeadingLevel:f,maxHeadingLevel:v}}),[s,l,f,v])),(0,m.jsx)(p,{toc:x,className:n,linkClassName:s,...g})}},996:(e,t,n)=>{n.d(t,{A:()=>g});n(6540);var i=n(4164),a=n(1312),o=n(5260),r=n(4848);function s(){return(0,r.jsx)(a.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function l(){return(0,r.jsx)(a.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function c(){return(0,r.jsx)(o.A,{children:(0,r.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}var d=n(7559),u=n(890);function m(e){let{className:t}=e;return(0,r.jsx)(u.A,{type:"caution",title:(0,r.jsx)(s,{}),className:(0,i.A)(t,d.G.common.unlistedBanner),children:(0,r.jsx)(l,{})})}function g(e){return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(c,{}),(0,r.jsx)(m,{...e})]})}},6676:(e,t,n)=>{n.d(t,{k:()=>d,J:()=>u});var i=n(6025),a=n(4586),o=n(6803);var r=n(7131);const s=e=>new Date(e).toISOString();function l(e){const t=e.map(m);return{author:1===t.length?t[0]:t}}function c(e,t,n){return e?{image:g({imageUrl:t(e,{absolute:!0}),caption:`title image for the blog post: ${n}`})}:{}}function d(e){const{siteConfig:t}=(0,a.A)(),{withBaseUrl:n}=(0,i.hH)(),{metadata:{blogDescription:o,blogTitle:r,permalink:d}}=e,u=`${t.url}${d}`;return{"@context":"https://schema.org","@type":"Blog","@id":u,mainEntityOfPage:u,headline:r,description:o,blogPost:e.items.map((e=>function(e,t,n){const{assets:i,frontMatter:a,metadata:o}=e,{date:r,title:d,description:u,lastUpdatedAt:m}=o,g=i.image??a.image,p=a.keywords??[],h=`${t.url}${o.permalink}`,f=m?s(m):void 0;return{"@type":"BlogPosting","@id":h,mainEntityOfPage:h,url:h,headline:d,name:d,description:u,datePublished:r,...f?{dateModified:f}:{},...l(o.authors),...c(g,n,d),...p?{keywords:p}:{}}}(e.content,t,n)))}}function u(){const e=function(){const e=(0,o.A)(),t=e?.data?.blogMetadata;if(!t)throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");return t}(),{assets:t,metadata:n}=(0,r.e)(),{siteConfig:d}=(0,a.A)(),{withBaseUrl:u}=(0,i.hH)(),{date:m,title:g,description:p,frontMatter:h,lastUpdatedAt:f}=n,v=t.image??h.image,x=h.keywords??[],b=f?s(f):void 0,j=`${d.url}${n.permalink}`;return{"@context":"https://schema.org","@type":"BlogPosting","@id":j,mainEntityOfPage:j,url:j,headline:g,name:g,description:p,datePublished:m,...b?{dateModified:b}:{},...l(n.authors),...c(v,u,g),...x?{keywords:x}:{},isPartOf:{"@type":"Blog","@id":`${d.url}${e.blogBasePath}`,name:e.blogTitle}}}function m(e){return{"@type":"Person",...e.name?{name:e.name}:{},...e.title?{description:e.title}:{},...e.url?{url:e.url}:{},...e.email?{email:e.email}:{},...e.imageURL?{image:e.imageURL}:{}}}function g(e){let{imageUrl:t,caption:n}=e;return{"@type":"ImageObject","@id":t,url:t,contentUrl:t,caption:n}}},4037:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var i=n(3028);n(4848);const a={...i.A,license:i.A.note}},890:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var i=n(4741),a=n(4848);function o(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,a.jsx)(i.A,{icon:"\ud83c\udfc5",...e}):(0,a.jsx)(a.Fragment,{children:(0,a.jsx)(i.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/ccc49370.7c7835f3.js b/assets/js/ccc49370.7c7835f3.js new file mode 100644 index 0000000000..9ff1e203c7 --- /dev/null +++ b/assets/js/ccc49370.7c7835f3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3249],{2907:(e,t,n)=>{n.d(t,{A:()=>O});n(6540);var a=n(4164),s=n(4096),i=n(4848);function r(e){let{children:t,className:n}=e;return(0,i.jsx)("article",{className:n,children:t})}var l=n(8774);const o={title:"title_f1Hy"};function c(e){let{className:t}=e;const{metadata:n,isBlogPostPage:r}=(0,s.e7)(),{permalink:c,title:d}=n,m=r?"h1":"h2";return(0,i.jsx)(m,{className:(0,a.A)(o.title,t),children:r?d:(0,i.jsx)(l.A,{to:c,children:d})})}var d=n(1312),m=n(5846),u=n(6266);const g={container:"container_mt6G"};function h(e){let{readingTime:t}=e;const n=function(){const{selectMessage:e}=(0,m.W)();return t=>{const n=Math.ceil(t);return e(n,(0,d.T)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:n}))}}();return(0,i.jsx)(i.Fragment,{children:n(t)})}function x(e){let{date:t,formattedDate:n}=e;return(0,i.jsx)("time",{dateTime:t,children:n})}function p(){return(0,i.jsx)(i.Fragment,{children:" \xb7 "})}function f(e){let{className:t}=e;const{metadata:n}=(0,s.e7)(),{date:r,readingTime:l}=n,o=(0,u.i)({day:"numeric",month:"long",year:"numeric",timeZone:"UTC"});return(0,i.jsxs)("div",{className:(0,a.A)(g.container,"margin-vert--md",t),children:[(0,i.jsx)(x,{date:r,formattedDate:(c=r,o.format(new Date(c)))}),void 0!==l&&(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(p,{}),(0,i.jsx)(h,{readingTime:l})]})]});var c}var v=n(6913);const j={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function b(e){let{className:t}=e;const{metadata:{authors:n},assets:r}=(0,s.e7)();if(0===n.length)return null;const l=n.every((e=>{let{name:t}=e;return!t})),o=1===n.length;return(0,i.jsx)("div",{className:(0,a.A)("margin-top--md margin-bottom--sm",l?j.imageOnlyAuthorRow:"row",t),children:n.map(((e,t)=>(0,i.jsx)("div",{className:(0,a.A)(!l&&(o?"col col--12":"col col--6"),l?j.imageOnlyAuthorCol:j.authorCol),children:(0,i.jsx)(v.A,{author:{...e,imageURL:r.authorsImageUrls[t]??e.imageURL}})},t)))})}function A(){return(0,i.jsxs)("header",{children:[(0,i.jsx)(c,{}),(0,i.jsx)(f,{}),(0,i.jsx)(b,{})]})}var N=n(440),_=n(8509);function L(e){let{children:t,className:n}=e;const{isBlogPostPage:r}=(0,s.e7)();return(0,i.jsx)("div",{id:r?N.LU:void 0,className:(0,a.A)("markdown",n),children:(0,i.jsx)(_.A,{children:t})})}var y=n(7559),C=n(4336),T=n(2053);function k(){return(0,i.jsx)("b",{children:(0,i.jsx)(d.A,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts",children:"Read more"})})}function H(e){const{blogPostTitle:t,...n}=e;return(0,i.jsx)(l.A,{"aria-label":(0,d.T)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t}),...n,children:(0,i.jsx)(k,{})})}function w(){const{metadata:e,isBlogPostPage:t}=(0,s.e7)(),{tags:n,title:r,editUrl:l,hasTruncateMarker:o,lastUpdatedBy:c,lastUpdatedAt:d}=e,m=!t&&o,u=n.length>0;if(!(u||m||l))return null;if(t){const e=!!(l||d||c);return(0,i.jsxs)("footer",{className:"docusaurus-mt-lg",children:[u&&(0,i.jsx)("div",{className:(0,a.A)("row","margin-top--sm",y.G.blog.blogFooterEditMetaRow),children:(0,i.jsx)("div",{className:"col",children:(0,i.jsx)(T.A,{tags:n})})}),e&&(0,i.jsx)(C.A,{className:(0,a.A)("margin-top--sm",y.G.blog.blogFooterEditMetaRow),editUrl:l,lastUpdatedAt:d,lastUpdatedBy:c})]})}return(0,i.jsxs)("footer",{className:"row docusaurus-mt-lg",children:[u&&(0,i.jsx)("div",{className:(0,a.A)("col",{"col--9":m}),children:(0,i.jsx)(T.A,{tags:n})}),m&&(0,i.jsx)("div",{className:(0,a.A)("col text--right",{"col--3":u}),children:(0,i.jsx)(H,{blogPostTitle:r,to:e.permalink})})]})}function O(e){let{children:t,className:n}=e;const l=function(){const{isBlogPostPage:e}=(0,s.e7)();return e?void 0:"margin-bottom--xl"}();return(0,i.jsxs)(r,{className:(0,a.A)(l,n),children:[(0,i.jsx)(A,{}),(0,i.jsx)(L,{children:t}),(0,i.jsx)(w,{})]})}},3858:(e,t,n)=>{n.r(t),n.d(t,{default:()=>j});n(6540);var a=n(4164),s=n(5500),i=n(7559),r=n(4096),l=n(8027),o=n(2907),c=n(1312),d=n(9022),m=n(4848);function u(e){const{nextItem:t,prevItem:n}=e;return(0,m.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,c.T)({id:"theme.blog.post.paginator.navAriaLabel",message:"Blog post page navigation",description:"The ARIA label for the blog posts pagination"}),children:[n&&(0,m.jsx)(d.A,{...n,subLabel:(0,m.jsx)(c.A,{id:"theme.blog.post.paginator.newerPost",description:"The blog post button label to navigate to the newer/previous post",children:"Newer post"})}),t&&(0,m.jsx)(d.A,{...t,subLabel:(0,m.jsx)(c.A,{id:"theme.blog.post.paginator.olderPost",description:"The blog post button label to navigate to the older/next post",children:"Older post"}),isNext:!0})]})}function g(){const{assets:e,metadata:t}=(0,r.e7)(),{title:n,description:a,date:i,tags:l,authors:o,frontMatter:c}=t,{keywords:d}=c,u=e.image??c.image;return(0,m.jsxs)(s.be,{title:n,description:a,keywords:d,image:u,children:[(0,m.jsx)("meta",{property:"og:type",content:"article"}),(0,m.jsx)("meta",{property:"article:published_time",content:i}),o.some((e=>e.url))&&(0,m.jsx)("meta",{property:"article:author",content:o.map((e=>e.url)).filter(Boolean).join(",")}),l.length>0&&(0,m.jsx)("meta",{property:"article:tag",content:l.map((e=>e.label)).join(",")})]})}var h=n(5260);function x(){const e=(0,r.J_)();return(0,m.jsx)(h.A,{children:(0,m.jsx)("script",{type:"application/ld+json",children:JSON.stringify(e)})})}var p=n(7763),f=n(1689);function v(e){let{sidebar:t,children:n}=e;const{metadata:a,toc:s}=(0,r.e7)(),{nextItem:i,prevItem:c,frontMatter:d}=a,{hide_table_of_contents:g,toc_min_heading_level:h,toc_max_heading_level:x}=d;return(0,m.jsxs)(l.A,{sidebar:t,toc:!g&&s.length>0?(0,m.jsx)(p.A,{toc:s,minHeadingLevel:h,maxHeadingLevel:x}):void 0,children:[(0,m.jsx)(f.A,{metadata:a}),(0,m.jsx)(o.A,{children:n}),(i||c)&&(0,m.jsx)(u,{nextItem:i,prevItem:c})]})}function j(e){const t=e.content;return(0,m.jsx)(r.in,{content:e.content,isBlogPostPage:!0,children:(0,m.jsxs)(s.e3,{className:(0,a.A)(i.G.wrapper.blogPages,i.G.page.blogPostPage),children:[(0,m.jsx)(g,{}),(0,m.jsx)(x,{}),(0,m.jsx)(v,{sidebar:e.sidebar,children:(0,m.jsx)(t,{})})]})})}},2234:(e,t,n)=>{n.d(t,{A:()=>c});n(6540);var a=n(4164),s=n(4084),i=n(7559),r=n(890),l=n(4848);function o(e){let{className:t}=e;return(0,l.jsx)(r.A,{type:"caution",title:(0,l.jsx)(s.Rc,{}),className:(0,a.A)(t,i.G.common.unlistedBanner),children:(0,l.jsx)(s.Uh,{})})}function c(e){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.AE,{}),(0,l.jsx)(o,{...e})]})}},1689:(e,t,n)=>{n.d(t,{A:()=>d});n(6540);var a=n(4164),s=n(4084),i=n(7559),r=n(890),l=n(4848);function o(e){let{className:t}=e;return(0,l.jsx)(r.A,{type:"caution",title:(0,l.jsx)(s.Yh,{}),className:(0,a.A)(t,i.G.common.draftBanner),children:(0,l.jsx)(s.TT,{})})}var c=n(2234);function d(e){let{metadata:t}=e;const{unlisted:n,frontMatter:a}=t;return(0,l.jsxs)(l.Fragment,{children:[(n||a.unlisted)&&(0,l.jsx)(c.A,{}),a.draft&&(0,l.jsx)(o,{})]})}},9022:(e,t,n)=>{n.d(t,{A:()=>r});n(6540);var a=n(4164),s=n(8774),i=n(4848);function r(e){const{permalink:t,title:n,subLabel:r,isNext:l}=e;return(0,i.jsxs)(s.A,{className:(0,a.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[r&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:r}),(0,i.jsx)("div",{className:"pagination-nav__label",children:n})]})}},7763:(e,t,n)=>{n.d(t,{A:()=>c});n(6540);var a=n(4164),s=n(5195);const i={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var r=n(4848);const l="table-of-contents__link toc-highlight",o="table-of-contents__link--active";function c(e){let{className:t,...n}=e;return(0,r.jsx)("div",{className:(0,a.A)(i.tableOfContents,"thin-scrollbar",t),children:(0,r.jsx)(s.A,{...n,linkClassName:l,linkActiveClassName:o})})}},5195:(e,t,n)=>{n.d(t,{A:()=>x});var a=n(6540),s=n(6342);function i(e){const t=e.map((e=>({...e,parentIndex:-1,children:[]}))),n=Array(7).fill(-1);t.forEach(((e,t)=>{const a=n.slice(2,e.level);e.parentIndex=Math.max(...a),n[e.level]=t}));const a=[];return t.forEach((e=>{const{parentIndex:n,...s}=e;n>=0?t[n].children.push(s):a.push(s)})),a}function r(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:a}=e;return t.flatMap((e=>{const t=r({toc:e.children,minHeadingLevel:n,maxHeadingLevel:a});return function(e){return e.level>=n&&e.level<=a}(e)?[{...e,children:t}]:t}))}function l(e){const t=e.getBoundingClientRect();return t.top===t.bottom?l(e.parentNode):t}function o(e,t){let{anchorTopOffset:n}=t;const a=e.find((e=>l(e).top>=n));if(a){return function(e){return e.top>0&&e.bottom{e.current=t?0:document.querySelector(".navbar").clientHeight}),[t]),e}function d(e){const t=(0,a.useRef)(void 0),n=c();(0,a.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:a,linkActiveClassName:s,minHeadingLevel:i,maxHeadingLevel:r}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(a),l=function(e){let{minHeadingLevel:t,maxHeadingLevel:n}=e;const a=[];for(let s=t;s<=n;s+=1)a.push(`h${s}.anchor`);return Array.from(document.querySelectorAll(a.join()))}({minHeadingLevel:i,maxHeadingLevel:r}),c=o(l,{anchorTopOffset:n.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,n){n?(t.current&&t.current!==e&&t.current.classList.remove(s),e.classList.add(s),t.current=e):e.classList.remove(s)}(e,e===d)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,n])}var m=n(8774),u=n(4848);function g(e){let{toc:t,className:n,linkClassName:a,isChild:s}=e;return t.length?(0,u.jsx)("ul",{className:s?void 0:n,children:t.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(m.A,{to:`#${e.id}`,className:a??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(g,{isChild:!0,toc:e.children,className:n,linkClassName:a})]},e.id)))}):null}const h=a.memo(g);function x(e){let{toc:t,className:n="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:o,minHeadingLevel:c,maxHeadingLevel:m,...g}=e;const x=(0,s.p)(),p=c??x.tableOfContents.minHeadingLevel,f=m??x.tableOfContents.maxHeadingLevel,v=function(e){let{toc:t,minHeadingLevel:n,maxHeadingLevel:s}=e;return(0,a.useMemo)((()=>r({toc:i(t),minHeadingLevel:n,maxHeadingLevel:s})),[t,n,s])}({toc:t,minHeadingLevel:p,maxHeadingLevel:f});return d((0,a.useMemo)((()=>{if(l&&o)return{linkClassName:l,linkActiveClassName:o,minHeadingLevel:p,maxHeadingLevel:f}}),[l,o,p,f])),(0,u.jsx)(h,{toc:v,className:n,linkClassName:l,...g})}},6133:(e,t,n)=>{n.d(t,{A:()=>l});n(6540);var a=n(4164),s=n(8774);const i={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};var r=n(4848);function l(e){let{permalink:t,label:n,count:l,description:o}=e;return(0,r.jsxs)(s.A,{href:t,title:o,className:(0,a.A)(i.tag,l?i.tagWithCount:i.tagRegular),children:[n,l&&(0,r.jsx)("span",{children:l})]})}},2053:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var a=n(4164),s=n(1312),i=n(6133);const r={tags:"tags_jXut",tag:"tag_QGVx"};var l=n(4848);function o(e){let{tags:t}=e;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("b",{children:(0,l.jsx)(s.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,l.jsx)("ul",{className:(0,a.A)(r.tags,"padding--none","margin-left--sm"),children:t.map((e=>(0,l.jsx)("li",{className:r.tag,children:(0,l.jsx)(i.A,{...e})},e.permalink)))})]})}},4084:(e,t,n)=>{n.d(t,{AE:()=>o,Rc:()=>r,TT:()=>d,Uh:()=>l,Yh:()=>c});n(6540);var a=n(1312),s=n(5260),i=n(4848);function r(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function l(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function o(){return(0,i.jsx)(s.A,{children:(0,i.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function c(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function d(){return(0,i.jsx)(a.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}},4037:(e,t,n)=>{n.d(t,{A:()=>s});n(6540);var a=n(3028);n(4848);const s={...a.A,license:a.A.note}},890:(e,t,n)=>{n.d(t,{A:()=>i});n(6540);var a=n(4741),s=n(4848);function i(e){return console.log("\ud83d\ude80 ~ AdmonitionWrapper ~ props:",e.type),"license"==e.type?(0,s.jsx)(a.A,{icon:"\ud83c\udfc5",...e}):(0,s.jsx)(s.Fragment,{children:(0,s.jsx)(a.A,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/cce945f2.0b73c9ef.js b/assets/js/cce945f2.0b73c9ef.js new file mode 100644 index 0000000000..ba0d340c77 --- /dev/null +++ b/assets/js/cce945f2.0b73c9ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9498],{4882:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var r=n(4848),o=n(8453);const c={},s="Interface: Button",i={id:"reference/api/model/button/interfaces/Button",title:"Interface: Button",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Button.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Button",permalink:"/docs/reference/api/model/button/interfaces/Button",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Button.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton"},next:{title:"Interface: LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"text",id:"text",level:3}];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-button",children:"Interface: Button"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"text",children:"text"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"text"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>i});var r=n(6540);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cce945f2.de86bfa8.js b/assets/js/cce945f2.de86bfa8.js deleted file mode 100644 index f11904567b..0000000000 --- a/assets/js/cce945f2.de86bfa8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9498],{4882:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var r=n(4848),o=n(8453);const c={},s="Interface: Button",i={id:"reference/api/model/button/interfaces/Button",title:"Interface: Button",description:"Properties",source:"@site/docs/reference/api/model/button/interfaces/Button.md",sourceDirName:"reference/api/model/button/interfaces",slug:"/reference/api/model/button/interfaces/Button",permalink:"/docs/reference/api/model/button/interfaces/Button",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/button/interfaces/Button.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: AdvancedButton",permalink:"/docs/reference/api/model/button/interfaces/AdvancedButton"},next:{title:"Interface: LocationButtonBody",permalink:"/docs/reference/api/model/button/interfaces/LocationButtonBody"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"text",id:"text",level:3}];function u(e){const t={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-button",children:"Interface: Button"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"text",children:"text"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"text"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>i});var r=n(6540);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cdd11b4d.4b76fa77.js b/assets/js/cdd11b4d.4b76fa77.js new file mode 100644 index 0000000000..2ec006e082 --- /dev/null +++ b/assets/js/cdd11b4d.4b76fa77.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9306],{6153:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var n=a(4848),t=a(8453);const r={},o="Type Alias: MessageId",i={id:"reference/api/model/aliases/type-aliases/MessageId",title:"Type Alias: MessageId",description:"MessageId: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/MessageId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/MessageId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId"},next:{title:"Type Alias: NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId"}},d={},c=[];function l(e){const s={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"type-alias-messageid",children:"Type Alias: MessageId"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"MessageId"}),": ",(0,n.jsx)(s.code,{children:"Brand"}),"<`${boolean}_${ChatId}_${string}`, ",(0,n.jsx)(s.code,{children:'"MessageId"'}),">"]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["The id of a message. The format is ",(0,n.jsx)(s.code,{children:"[boolean]_[ChatId]_[random character string]"})]}),"\n",(0,n.jsx)(s.p,{children:"Example:"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:'"false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"'})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>o,x:()=>i});var n=a(6540);const t={},r=n.createContext(t);function o(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cdd11b4d.68a06c8f.js b/assets/js/cdd11b4d.68a06c8f.js deleted file mode 100644 index 6abeeb42cd..0000000000 --- a/assets/js/cdd11b4d.68a06c8f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9306],{6153:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var n=a(4848),t=a(8453);const r={},o="Type Alias: MessageId",i={id:"reference/api/model/aliases/type-aliases/MessageId",title:"Type Alias: MessageId",description:"MessageId: Brand\\",source:"@site/docs/reference/api/model/aliases/type-aliases/MessageId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/MessageId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: GroupId",permalink:"/docs/reference/api/model/aliases/type-aliases/GroupId"},next:{title:"Type Alias: NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId"}},d={},c=[];function l(e){const s={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"type-alias-messageid",children:"Type Alias: MessageId"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"MessageId"}),": ",(0,n.jsx)(s.code,{children:"Brand"}),"<`${boolean}_${ChatId}_${string}`, ",(0,n.jsx)(s.code,{children:'"MessageId"'}),">"]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["The id of a message. The format is ",(0,n.jsx)(s.code,{children:"[boolean]_[ChatId]_[random character string]"})]}),"\n",(0,n.jsx)(s.p,{children:"Example:"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:'"false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"'})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>o,x:()=>i});var n=a(6540);const t={},r=n.createContext(t);function o(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ce48d423.412a62ed.js b/assets/js/ce48d423.412a62ed.js new file mode 100644 index 0000000000..e88f9fc203 --- /dev/null +++ b/assets/js/ce48d423.412a62ed.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9466],{6907:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=t(4848),o=t(8453);const i={},r="Reacting To Group Events",s={id:"how-to/react-to-group-events",title:"Reacting To Group Events",description:"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).",source:"@site/docs/how-to/react-to-group-events.md",sourceDirName:"how-to",slug:"/how-to/react-to-group-events",permalink:"/docs/how-to/react-to-group-events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/react-to-group-events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"More examples",permalink:"/docs/how-to/misc"},next:{title:"read-state",permalink:"/docs/how-to/read-state"}},c={},l=[{value:"Listening to participant change events from all groups",id:"listening-to-participant-change-events-from-all-groups",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"reacting-to-group-events",children:"Reacting To Group Events"})}),"\n",(0,a.jsx)(n.p,{children:"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]])."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'import {\n create,\n Client,\n ParticipantChangedEventModel,\n} from "@open-wa/wa-automate";\n\nfunction start(client: Client) {\n const groupChatId = "00000000000-11111111111@g.us";\n client.onParticipantsChanged(\n groupChatId,\n async (changeEvent: ParticipantChangedEventModel) => {\n if (changeEvent.action == "add") {\n // It is possible that multiple accounts get added\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n groupChatId,\n `@${number} has been added!`\n )\n )\n );\n }\n if (changeEvent.action == "remove") {\n // It is possible that multiple accounts get removed\n //remember: all client methods are promises!\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n groupChatId,\n `@${number} has been removed!`\n )\n )\n );\n }\n }\n );\n}\n\ncreate().then((client) => start(client));\n'})}),"\n",(0,a.jsx)(n.h2,{id:"listening-to-participant-change-events-from-all-groups",children:"Listening to participant change events from all groups"}),"\n",(0,a.jsxs)(n.p,{children:["If you want to listen to participant change requests from all groups, you can get a list of all groups [[getAllChatIds]], filter for groups ",(0,a.jsx)(n.code,{children:".filter(id=>id.includes('@g.us')"})," then use the above method. However this results in multiple listeners in the browser and can have detrimental performance implications."]}),"\n",(0,a.jsx)(n.p,{children:"For better performance and stability you can use the Insiders Feature [[onGlobalParticipantsChanged]]."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'import {\n create,\n Client,\n ParticipantChangedEventModel,\n} from "@open-wa/wa-automate";\n\nfunction start(client: Client) {\n client.onGlobalParticipantsChanged(\n async (changeEvent: ParticipantChangedEventModel) => {\n if (changeEvent.action == "add") {\n // It is possible that multiple accounts get added\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n changeEvent.chat,\n `@${number} has been added!`\n )\n )\n );\n }\n if (changeEvent.action == "remove") {\n // It is possible that multiple accounts get removed\n //remember: all client methods are promises!\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n changeEvent.chat,\n `@${number} has been removed!`\n )\n )\n );\n }\n }\n );\n}\n\ncreate().then((client) => start(client));\n'})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>s});var a=t(6540);const o={},i=a.createContext(o);function r(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ce48d423.b140e27c.js b/assets/js/ce48d423.b140e27c.js deleted file mode 100644 index 6d74746d50..0000000000 --- a/assets/js/ce48d423.b140e27c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9466],{6907:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=t(4848),o=t(8453);const i={},r="Reacting To Group Events",s={id:"how-to/react-to-group-events",title:"Reacting To Group Events",description:"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).",source:"@site/docs/how-to/react-to-group-events.md",sourceDirName:"how-to",slug:"/how-to/react-to-group-events",permalink:"/docs/how-to/react-to-group-events",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/react-to-group-events.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"More examples",permalink:"/docs/how-to/misc"},next:{title:"read-state",permalink:"/docs/how-to/read-state"}},c={},l=[{value:"Listening to participant change events from all groups",id:"listening-to-participant-change-events-from-all-groups",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"reacting-to-group-events",children:"Reacting To Group Events"}),"\n",(0,a.jsx)(n.p,{children:"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]])."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'import {\n create,\n Client,\n ParticipantChangedEventModel,\n} from "@open-wa/wa-automate";\n\nfunction start(client: Client) {\n const groupChatId = "00000000000-11111111111@g.us";\n client.onParticipantsChanged(\n groupChatId,\n async (changeEvent: ParticipantChangedEventModel) => {\n if (changeEvent.action == "add") {\n // It is possible that multiple accounts get added\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n groupChatId,\n `@${number} has been added!`\n )\n )\n );\n }\n if (changeEvent.action == "remove") {\n // It is possible that multiple accounts get removed\n //remember: all client methods are promises!\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n groupChatId,\n `@${number} has been removed!`\n )\n )\n );\n }\n }\n );\n}\n\ncreate().then((client) => start(client));\n'})}),"\n",(0,a.jsx)(n.h2,{id:"listening-to-participant-change-events-from-all-groups",children:"Listening to participant change events from all groups"}),"\n",(0,a.jsxs)(n.p,{children:["If you want to listen to participant change requests from all groups, you can get a list of all groups [[getAllChatIds]], filter for groups ",(0,a.jsx)(n.code,{children:".filter(id=>id.includes('@g.us')"})," then use the above method. However this results in multiple listeners in the browser and can have detrimental performance implications."]}),"\n",(0,a.jsx)(n.p,{children:"For better performance and stability you can use the Insiders Feature [[onGlobalParticipantsChanged]]."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'import {\n create,\n Client,\n ParticipantChangedEventModel,\n} from "@open-wa/wa-automate";\n\nfunction start(client: Client) {\n client.onGlobalParticipantsChanged(\n async (changeEvent: ParticipantChangedEventModel) => {\n if (changeEvent.action == "add") {\n // It is possible that multiple accounts get added\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n changeEvent.chat,\n `@${number} has been added!`\n )\n )\n );\n }\n if (changeEvent.action == "remove") {\n // It is possible that multiple accounts get removed\n //remember: all client methods are promises!\n await Promise.all(\n changeEvent.who.map((number) =>\n client.sendTextWithMentions(\n changeEvent.chat,\n `@${number} has been removed!`\n )\n )\n );\n }\n }\n );\n}\n\ncreate().then((client) => start(client));\n'})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>s});var a=t(6540);const o={},i=a.createContext(o);function r(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d23fc473.1fcf6734.js b/assets/js/d23fc473.1fcf6734.js new file mode 100644 index 0000000000..bcc0d1dad9 --- /dev/null +++ b/assets/js/d23fc473.1fcf6734.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5181],{2814:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=n(4848),a=n(8453);const i={},c="api/model/message",o={id:"reference/api/model/message/index",title:"api/model/message",description:"Index",source:"@site/docs/reference/api/model/message/index.md",sourceDirName:"reference/api/model/message",slug:"/reference/api/model/message/",permalink:"/docs/reference/api/model/message/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"},next:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"}},t={},l=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"apimodelmessage",children:"api/model/message"})}),"\n",(0,r.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})}),"\n"]})]})}function m(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var r=n(6540);const a={},i=r.createContext(a);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d23fc473.3709f52d.js b/assets/js/d23fc473.3709f52d.js deleted file mode 100644 index 06a45fd21c..0000000000 --- a/assets/js/d23fc473.3709f52d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5181],{2814:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=n(4848),a=n(8453);const i={},c="api/model/message",o={id:"reference/api/model/message/index",title:"api/model/message",description:"Index",source:"@site/docs/reference/api/model/message/index.md",sourceDirName:"reference/api/model/message",slug:"/reference/api/model/message/",permalink:"/docs/reference/api/model/message/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"},next:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"}},t={},l=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"apimodelmessage",children:"api/model/message"}),"\n",(0,r.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})}),"\n"]})]})}function m(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var r=n(6540);const a={},i=r.createContext(a);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d42a3ae7.064be20a.js b/assets/js/d42a3ae7.064be20a.js deleted file mode 100644 index 273143a509..0000000000 --- a/assets/js/d42a3ae7.064be20a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[452],{2269:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=n(4848),s=n(8453);const a={},o="Interface: QuoteMap",c={id:"reference/api/model/message/interfaces/QuoteMap",title:"Interface: QuoteMap",description:"Indexable",source:"@site/docs/reference/api/model/message/interfaces/QuoteMap.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/QuoteMap.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote"},next:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"}},i={},d=[{value:"Indexable",id:"indexable",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-quotemap",children:"Interface: QuoteMap"}),"\n",(0,r.jsx)(t.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(t.p,{children:["[",(0,r.jsx)(t.code,{children:"messageId"}),": ",(0,r.jsx)(t.code,{children:"string"}),"]: ",(0,r.jsx)(t.code,{children:"object"})]})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d42a3ae7.77f151d7.js b/assets/js/d42a3ae7.77f151d7.js new file mode 100644 index 0000000000..91bb7d7808 --- /dev/null +++ b/assets/js/d42a3ae7.77f151d7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[452],{2269:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var r=n(4848),a=n(8453);const s={},c="Interface: QuoteMap",o={id:"reference/api/model/message/interfaces/QuoteMap",title:"Interface: QuoteMap",description:"Indexable",source:"@site/docs/reference/api/model/message/interfaces/QuoteMap.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/QuoteMap.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote"},next:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"}},i={},d=[{value:"Indexable",id:"indexable",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-quotemap",children:"Interface: QuoteMap"})}),"\n",(0,r.jsx)(t.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(t.p,{children:["[",(0,r.jsx)(t.code,{children:"messageId"}),": ",(0,r.jsx)(t.code,{children:"string"}),"]: ",(0,r.jsx)(t.code,{children:"object"})]})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var r=n(6540);const a={},s=r.createContext(a);function c(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d47ac4be.37026bc1.js b/assets/js/d47ac4be.37026bc1.js deleted file mode 100644 index e9c793b08f..0000000000 --- a/assets/js/d47ac4be.37026bc1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4125],{4809:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var r=a(4848),t=a(8453);const i={},c="api/model/chat",s={id:"reference/api/model/chat/index",title:"api/model/chat",description:"Index",source:"@site/docs/reference/api/model/chat/index.md",sourceDirName:"reference/api/model/chat",slug:"/reference/api/model/chat/",permalink:"/docs/reference/api/model/chat/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Call",permalink:"/docs/reference/api/model/call/interfaces/Call"},next:{title:"Enumeration: ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration"}},l={},o=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"apimodelchat",children:"api/model/chat"}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>c,x:()=>s});var r=a(6540);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d47ac4be.39498563.js b/assets/js/d47ac4be.39498563.js new file mode 100644 index 0000000000..28aac308fc --- /dev/null +++ b/assets/js/d47ac4be.39498563.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4125],{4809:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var r=a(4848),t=a(8453);const i={},c="api/model/chat",s={id:"reference/api/model/chat/index",title:"api/model/chat",description:"Index",source:"@site/docs/reference/api/model/chat/index.md",sourceDirName:"reference/api/model/chat",slug:"/reference/api/model/chat/",permalink:"/docs/reference/api/model/chat/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Call",permalink:"/docs/reference/api/model/call/interfaces/Call"},next:{title:"Enumeration: ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration"}},l={},o=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function d(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"apimodelchat",children:"api/model/chat"})}),"\n",(0,r.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>c,x:()=>s});var r=a(6540);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d6466469.00db3a9d.js b/assets/js/d6466469.00db3a9d.js deleted file mode 100644 index 5c194a1ed0..0000000000 --- a/assets/js/d6466469.00db3a9d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1082],{9681:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>f,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=s(4848),i=s(8453);const t={},r="api/model/sessionInfo",c={id:"reference/api/model/sessionInfo/index",title:"api/model/sessionInfo",description:"Index",source:"@site/docs/reference/api/model/sessionInfo/index.md",sourceDirName:"reference/api/model/sessionInfo",slug:"/reference/api/model/sessionInfo/",permalink:"/docs/reference/api/model/sessionInfo/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord"},next:{title:"Interface: HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck"}},a={},d=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"apimodelsessioninfo",children:"api/model/sessionInfo"}),"\n",(0,o.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,o.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:"HealthCheck"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:"SessionInfo"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var o=s(6540);const i={},t=o.createContext(i);function r(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d6466469.4b1210e8.js b/assets/js/d6466469.4b1210e8.js new file mode 100644 index 0000000000..56df50f5b0 --- /dev/null +++ b/assets/js/d6466469.4b1210e8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1082],{9681:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>f,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=s(4848),i=s(8453);const r={},t="api/model/sessionInfo",c={id:"reference/api/model/sessionInfo/index",title:"api/model/sessionInfo",description:"Index",source:"@site/docs/reference/api/model/sessionInfo/index.md",sourceDirName:"reference/api/model/sessionInfo",slug:"/reference/api/model/sessionInfo/",permalink:"/docs/reference/api/model/sessionInfo/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: ReactionRecord",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord"},next:{title:"Interface: HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck"}},a={},d=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"apimodelsessioninfo",children:"api/model/sessionInfo"})}),"\n",(0,o.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,o.jsx)(n.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:"HealthCheck"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:"SessionInfo"})}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var o=s(6540);const i={},r=o.createContext(i);function t(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d88d39d7.c132566b.js b/assets/js/d88d39d7.c132566b.js new file mode 100644 index 0000000000..a719a999b4 --- /dev/null +++ b/assets/js/d88d39d7.c132566b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2848],{5744:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>p,frontMatter:()=>n,metadata:()=>d,toc:()=>o});var i=r(4848),a=r(8453);const n={},l="Type Alias: NonSerializedId",d={id:"reference/api/model/aliases/type-aliases/NonSerializedId",title:"Type Alias: NonSerializedId",description:"NonSerializedId: object",source:"@site/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId"},next:{title:"Type Alias: WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers"}},t={},o=[{value:"Type declaration",id:"type-declaration",level:2},{value:"_serialized",id:"_serialized",level:3},{value:"server",id:"server",level:3},{value:"user",id:"user",level:3}];function c(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"type-alias-nonserializedid",children:"Type Alias: NonSerializedId"})}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"NonSerializedId"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsx)(s.h3,{id:"_serialized",children:"_serialized"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"_serialized"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"server",children:"server"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"server"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:(0,i.jsx)(s.code,{children:"WaServers"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"user",children:"user"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"user"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:(0,i.jsx)(s.code,{children:"AccountNumber"})})]}),"\n"]})]})}function p(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>l,x:()=>d});var i=r(6540);const a={},n=i.createContext(a);function l(e){const s=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),i.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d88d39d7.e2f6fd46.js b/assets/js/d88d39d7.e2f6fd46.js deleted file mode 100644 index 02570f88f1..0000000000 --- a/assets/js/d88d39d7.e2f6fd46.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2848],{5744:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>p,frontMatter:()=>n,metadata:()=>d,toc:()=>o});var i=r(4848),a=r(8453);const n={},l="Type Alias: NonSerializedId",d={id:"reference/api/model/aliases/type-aliases/NonSerializedId",title:"Type Alias: NonSerializedId",description:"NonSerializedId: object",source:"@site/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/NonSerializedId",permalink:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MessageId",permalink:"/docs/reference/api/model/aliases/type-aliases/MessageId"},next:{title:"Type Alias: WaServers",permalink:"/docs/reference/api/model/aliases/type-aliases/WaServers"}},t={},o=[{value:"Type declaration",id:"type-declaration",level:2},{value:"_serialized",id:"_serialized",level:3},{value:"server",id:"server",level:3},{value:"user",id:"user",level:3}];function c(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"type-alias-nonserializedid",children:"Type Alias: NonSerializedId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"NonSerializedId"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsx)(s.h3,{id:"_serialized",children:"_serialized"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"_serialized"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"server",children:"server"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"server"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:(0,i.jsx)(s.code,{children:"WaServers"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"user",children:"user"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"user"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:(0,i.jsx)(s.code,{children:"AccountNumber"})})]}),"\n"]})]})}function p(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>l,x:()=>d});var i=r(6540);const a={},n=i.createContext(a);function l(e){const s=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),i.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9f32620.0e2fc2f8.js b/assets/js/d9f32620.0e2fc2f8.js deleted file mode 100644 index 466bde2b20..0000000000 --- a/assets/js/d9f32620.0e2fc2f8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5557],{7447:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>i});var n=s(4848),t=s(8453);const r={slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},l=void 0,a={permalink:"/blog/welcome",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md",source:"@site/blog/2021-08-26-welcome/index.md",title:"Welcome",description:"Docusaurus blogging features are powered by the blog plugin.",date:"2021-08-26T00:00:00.000Z",tags:[{inline:!1,label:"Facebook",permalink:"/blog/tags/facebook",description:"Facebook tag description"},{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.405,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber"},{name:"Yangshun Tay",title:"Front End Engineer @ Facebook",url:"https://github.com/yangshun",imageURL:"https://github.com/yangshun.png",key:"yangshun"}],frontMatter:{slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},unlisted:!1,nextItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"}},c={authorsImageUrls:[void 0,void 0]},i=[];function u(e){const o={a:"a",code:"code",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/blog",children:"Docusaurus blogging features"})," are powered by the ",(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog",children:"blog plugin"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["Simply add Markdown files (or folders) to the ",(0,n.jsx)(o.code,{children:"blog"})," directory."]}),"\n",(0,n.jsxs)(o.p,{children:["Regular blog authors can be added to ",(0,n.jsx)(o.code,{children:"authors.yml"}),"."]}),"\n",(0,n.jsx)(o.p,{children:"The blog post date can be extracted from filenames, such as:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome.md"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome/index.md"})}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"A blog post folder can be convenient to co-locate blog post images:"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"Docusaurus Plushie",src:s(575).A+"",width:"1500",height:"500"})}),"\n",(0,n.jsx)(o.p,{children:"The blog supports tags as well!"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"And if you don't want a blog"}),": just delete this directory, and use ",(0,n.jsx)(o.code,{children:"blog: false"})," in your Docusaurus config."]})]})}function d(e={}){const{wrapper:o}={...(0,t.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},575:(e,o,s)=>{s.d(o,{A:()=>n});const n=s.p+"assets/images/docusaurus-plushie-banner-a60f7593abca1e3eef26a9afa244e4fb.jpeg"},8453:(e,o,s)=>{s.d(o,{R:()=>l,x:()=>a});var n=s(6540);const t={},r=n.createContext(t);function l(e){const o=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),n.createElement(r.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9f32620.aff62161.js b/assets/js/d9f32620.aff62161.js new file mode 100644 index 0000000000..829578d138 --- /dev/null +++ b/assets/js/d9f32620.aff62161.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5557],{7447:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>l,metadata:()=>a,toc:()=>i});var n=s(4848),t=s(8453);const l={slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},r=void 0,a={permalink:"/blog/welcome",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md",source:"@site/blog/2021-08-26-welcome/index.md",title:"Welcome",description:"Docusaurus blogging features are powered by the blog plugin.",date:"2021-08-26T00:00:00.000Z",tags:[{inline:!1,label:"Facebook",permalink:"/blog/tags/facebook",description:"Facebook tag description"},{inline:!1,label:"Hello",permalink:"/blog/tags/hello",description:"Hello tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.405,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber",page:null},{name:"Yangshun Tay",title:"Front End Engineer @ Facebook",url:"https://github.com/yangshun",imageURL:"https://github.com/yangshun.png",key:"yangshun",page:null}],frontMatter:{slug:"welcome",title:"Welcome",authors:["slorber","yangshun"],tags:["facebook","hello","docusaurus"]},unlisted:!1,nextItem:{title:"MDX Blog Post",permalink:"/blog/mdx-blog-post"}},c={authorsImageUrls:[void 0,void 0]},i=[];function u(e){const o={a:"a",code:"code",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/blog",children:"Docusaurus blogging features"})," are powered by the ",(0,n.jsx)(o.a,{href:"https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog",children:"blog plugin"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["Simply add Markdown files (or folders) to the ",(0,n.jsx)(o.code,{children:"blog"})," directory."]}),"\n",(0,n.jsxs)(o.p,{children:["Regular blog authors can be added to ",(0,n.jsx)(o.code,{children:"authors.yml"}),"."]}),"\n",(0,n.jsx)(o.p,{children:"The blog post date can be extracted from filenames, such as:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome.md"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"2019-05-30-welcome/index.md"})}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"A blog post folder can be convenient to co-locate blog post images:"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.img,{alt:"Docusaurus Plushie",src:s(575).A+"",width:"1500",height:"500"})}),"\n",(0,n.jsx)(o.p,{children:"The blog supports tags as well!"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"And if you don't want a blog"}),": just delete this directory, and use ",(0,n.jsx)(o.code,{children:"blog: false"})," in your Docusaurus config."]})]})}function d(e={}){const{wrapper:o}={...(0,t.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},575:(e,o,s)=>{s.d(o,{A:()=>n});const n=s.p+"assets/images/docusaurus-plushie-banner-a60f7593abca1e3eef26a9afa244e4fb.jpeg"},8453:(e,o,s)=>{s.d(o,{R:()=>r,x:()=>a});var n=s(6540);const t={},l=n.createContext(t);function r(e){const o=n.useContext(l);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(l.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dbe3b6b9.496fb1b0.js b/assets/js/dbe3b6b9.496fb1b0.js new file mode 100644 index 0000000000..79e8c2810d --- /dev/null +++ b/assets/js/dbe3b6b9.496fb1b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5438],{7067:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var s=t(4848),a=t(8453);const o={},c="Best Practice",i={id:"advanced/best-practices",title:"Best Practice",description:"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:",source:"@site/docs/advanced/best-practices.md",sourceDirName:"advanced",slug:"/advanced/best-practices",permalink:"/docs/advanced/best-practices",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/advanced/best-practices.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Congratulations!",permalink:"/docs/tutorial-basics/congratulations"},next:{title:"Tutorial - Extras",permalink:"/docs/category/tutorial---extras"}},r={},l=[];function u(e){const n={a:"a",code:"code",h1:"h1",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"best-practice",children:"Best Practice"})}),"\n",(0,s.jsx)(n.p,{children:"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"Keep the session alive"}),"\n",(0,s.jsx)(n.li,{children:"Offload most work off of your @open-wa/wa-automate setup (i.e forward all events to a pubsub or something)"}),"\n",(0,s.jsx)(n.li,{children:"Keep the phone nearby just in case you need to reauthenticate"}),"\n",(0,s.jsx)(n.li,{children:"Use a chrome instance instead of the default chromium instance"}),"\n",(0,s.jsx)(n.li,{children:"Use headless: false for easy & quick visual debugging"}),"\n",(0,s.jsx)(n.li,{children:"Implement the unread messages functionality on creation of a session so you don't miss any messages upon any downtime."}),"\n",(0,s.jsxs)(n.li,{children:["Implement a ",(0,s.jsx)(n.a,{href:"https://github.com/sindresorhus/p-queue",children:"promise-queue"})]}),"\n",(0,s.jsx)(n.li,{children:"Use a unique and valid custom user-agent"}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"await"})," all @open-wa/wa-automate methods just in case"]}),"\n",(0,s.jsx)(n.li,{children:"Do not run your s@open-wa/wa-automate instance on a Windows machine."}),"\n",(0,s.jsxs)(n.li,{children:["Always ",(0,s.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#kill",children:"kill the session safely"})," upon error or SIGINT."]}),"\n",(0,s.jsx)(n.li,{children:"Regularly restart your process to manage memory consumption"}),"\n",(0,s.jsxs)(n.li,{children:["If memory leaks continue to be an issue then use ",(0,s.jsx)(n.code,{children:"cacheEnabled:false"})," in the config to disable the cache on the page."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"import { create, Client} from '@open-wa/wa-automate';\nconst { default: PQueue } = require(\"p-queue\");\n\nconst queue = new PQueue({\n concurrency: 4,\n autoStart:false\n });\n\nconst proc = async message => {\n //do something with the message here\n console.log(message)\n return true;\n}\n\nconst processMessage = message => queue.add(()=>proc(message));\n\nasync function start(client: Client) {\n const unreadMessages = await client.getAllUnreadMessages();\n unreadMessages.forEach(processMessage)\n ...\n await client.onMessage(processMessage);\n queue.start();\n}\n\ncreate().then(client => start(client));\n\n//create takes 1 argument and that is the config object :\n// https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html\n\ncreate({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n headless: false,\n autoRefresh:true,\n cacheEnabled:false,\n customUserAgent: 'some custom user agent'\n})\n.then(client => start(client));\n"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>i});var s=t(6540);const a={},o=s.createContext(a);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dbe3b6b9.dc627c80.js b/assets/js/dbe3b6b9.dc627c80.js deleted file mode 100644 index 179c1ac514..0000000000 --- a/assets/js/dbe3b6b9.dc627c80.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5438],{7067:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var s=t(4848),a=t(8453);const o={},c="Best Practice",i={id:"advanced/best-practices",title:"Best Practice",description:"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:",source:"@site/docs/advanced/best-practices.md",sourceDirName:"advanced",slug:"/advanced/best-practices",permalink:"/docs/advanced/best-practices",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/advanced/best-practices.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Congratulations!",permalink:"/docs/tutorial-basics/congratulations"},next:{title:"Tutorial - Extras",permalink:"/docs/category/tutorial---extras"}},r={},l=[];function u(e){const n={a:"a",code:"code",h1:"h1",li:"li",ol:"ol",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"best-practice",children:"Best Practice"}),"\n",(0,s.jsx)(n.p,{children:"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"Keep the session alive"}),"\n",(0,s.jsx)(n.li,{children:"Offload most work off of your @open-wa/wa-automate setup (i.e forward all events to a pubsub or something)"}),"\n",(0,s.jsx)(n.li,{children:"Keep the phone nearby just in case you need to reauthenticate"}),"\n",(0,s.jsx)(n.li,{children:"Use a chrome instance instead of the default chromium instance"}),"\n",(0,s.jsx)(n.li,{children:"Use headless: false for easy & quick visual debugging"}),"\n",(0,s.jsx)(n.li,{children:"Implement the unread messages functionality on creation of a session so you don't miss any messages upon any downtime."}),"\n",(0,s.jsxs)(n.li,{children:["Implement a ",(0,s.jsx)(n.a,{href:"https://github.com/sindresorhus/p-queue",children:"promise-queue"})]}),"\n",(0,s.jsx)(n.li,{children:"Use a unique and valid custom user-agent"}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"await"})," all @open-wa/wa-automate methods just in case"]}),"\n",(0,s.jsx)(n.li,{children:"Do not run your s@open-wa/wa-automate instance on a Windows machine."}),"\n",(0,s.jsxs)(n.li,{children:["Always ",(0,s.jsx)(n.a,{href:"https://open-wa.github.io/wa-automate-nodejs/classes/client.html#kill",children:"kill the session safely"})," upon error or SIGINT."]}),"\n",(0,s.jsx)(n.li,{children:"Regularly restart your process to manage memory consumption"}),"\n",(0,s.jsxs)(n.li,{children:["If memory leaks continue to be an issue then use ",(0,s.jsx)(n.code,{children:"cacheEnabled:false"})," in the config to disable the cache on the page."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"import { create, Client} from '@open-wa/wa-automate';\nconst { default: PQueue } = require(\"p-queue\");\n\nconst queue = new PQueue({\n concurrency: 4,\n autoStart:false\n });\n\nconst proc = async message => {\n //do something with the message here\n console.log(message)\n return true;\n}\n\nconst processMessage = message => queue.add(()=>proc(message));\n\nasync function start(client: Client) {\n const unreadMessages = await client.getAllUnreadMessages();\n unreadMessages.forEach(processMessage)\n ...\n await client.onMessage(processMessage);\n queue.start();\n}\n\ncreate().then(client => start(client));\n\n//create takes 1 argument and that is the config object :\n// https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html\n\ncreate({\n // For Mac:\n executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',\n // For Windows:\n // executablePath: 'C:\\\\Program Files (x86)\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe',\n headless: false,\n autoRefresh:true,\n cacheEnabled:false,\n customUserAgent: 'some custom user agent'\n})\n.then(client => start(client));\n"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>i});var s=t(6540);const a={},o=s.createContext(a);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dee01960.4b4e298f.js b/assets/js/dee01960.4b4e298f.js new file mode 100644 index 0000000000..76e73f0cdc --- /dev/null +++ b/assets/js/dee01960.4b4e298f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6629],{8382:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var r=i(4848),o=i(8453);const t={},s="Enumeration: NotificationLanguage",c={id:"reference/api/model/config/enumerations/NotificationLanguage",title:"Enumeration: NotificationLanguage",description:"The available languages for the host security notification",source:"@site/docs/reference/api/model/config/enumerations/NotificationLanguage.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/NotificationLanguage.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType"},next:{title:"Enumeration: OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError"}},d={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEDE",id:"dede",level:3},{value:"ENGB",id:"engb",level:3},{value:"ES",id:"es",level:3},{value:"IDID",id:"idid",level:3},{value:"ITIT",id:"itit",level:3},{value:"NLNL",id:"nlnl",level:3},{value:"PTBR",id:"ptbr",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-notificationlanguage",children:"Enumeration: NotificationLanguage"})}),"\n",(0,r.jsx)(n.p,{children:"The available languages for the host security notification"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"dede",children:"DEDE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DEDE"}),": ",(0,r.jsx)(n.code,{children:'"de-de"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"engb",children:"ENGB"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ENGB"}),": ",(0,r.jsx)(n.code,{children:'"en-gb"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"es",children:"ES"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ES"}),": ",(0,r.jsx)(n.code,{children:'"es"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"idid",children:"IDID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IDID"}),": ",(0,r.jsx)(n.code,{children:'"id-id"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"itit",children:"ITIT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ITIT"}),": ",(0,r.jsx)(n.code,{children:'"it-it"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nlnl",children:"NLNL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NLNL"}),": ",(0,r.jsx)(n.code,{children:'"nl-nl"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ptbr",children:"PTBR"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PTBR"}),": ",(0,r.jsx)(n.code,{children:'"pt-br"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var r=i(6540);const o={},t=r.createContext(o);function s(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dee01960.c9f07614.js b/assets/js/dee01960.c9f07614.js deleted file mode 100644 index 12e6c2e07b..0000000000 --- a/assets/js/dee01960.c9f07614.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6629],{8382:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=i(4848),o=i(8453);const t={},s="Enumeration: NotificationLanguage",c={id:"reference/api/model/config/enumerations/NotificationLanguage",title:"Enumeration: NotificationLanguage",description:"The available languages for the host security notification",source:"@site/docs/reference/api/model/config/enumerations/NotificationLanguage.md",sourceDirName:"reference/api/model/config/enumerations",slug:"/reference/api/model/config/enumerations/NotificationLanguage",permalink:"/docs/reference/api/model/config/enumerations/NotificationLanguage",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/config/enumerations/NotificationLanguage.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: LicenseType",permalink:"/docs/reference/api/model/config/enumerations/LicenseType"},next:{title:"Enumeration: OnError",permalink:"/docs/reference/api/model/config/enumerations/OnError"}},l={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEDE",id:"dede",level:3},{value:"ENGB",id:"engb",level:3},{value:"ES",id:"es",level:3},{value:"IDID",id:"idid",level:3},{value:"ITIT",id:"itit",level:3},{value:"NLNL",id:"nlnl",level:3},{value:"PTBR",id:"ptbr",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-notificationlanguage",children:"Enumeration: NotificationLanguage"}),"\n",(0,r.jsx)(n.p,{children:"The available languages for the host security notification"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"dede",children:"DEDE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"DEDE"}),": ",(0,r.jsx)(n.code,{children:'"de-de"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"engb",children:"ENGB"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ENGB"}),": ",(0,r.jsx)(n.code,{children:'"en-gb"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"es",children:"ES"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ES"}),": ",(0,r.jsx)(n.code,{children:'"es"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"idid",children:"IDID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IDID"}),": ",(0,r.jsx)(n.code,{children:'"id-id"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"itit",children:"ITIT"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ITIT"}),": ",(0,r.jsx)(n.code,{children:'"it-it"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nlnl",children:"NLNL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NLNL"}),": ",(0,r.jsx)(n.code,{children:'"nl-nl"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ptbr",children:"PTBR"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"PTBR"}),": ",(0,r.jsx)(n.code,{children:'"pt-br"'})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var r=i(6540);const o={},t=r.createContext(o);function s(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dff1c289.73eb9fd9.js b/assets/js/dff1c289.73eb9fd9.js new file mode 100644 index 0000000000..793922ee4b --- /dev/null +++ b/assets/js/dff1c289.73eb9fd9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1724],{8043:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var o=n(4848),r=n(8453);const i={sidebar_position:1},t="Manage Docs Versions",d={id:"tutorial-extras/manage-docs-versions",title:"Manage Docs Versions",description:"Docusaurus can manage multiple versions of your docs.",source:"@site/docs/tutorial-extras/manage-docs-versions.md",sourceDirName:"tutorial-extras",slug:"/tutorial-extras/manage-docs-versions",permalink:"/docs/tutorial-extras/manage-docs-versions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-extras/manage-docs-versions.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Tutorial - Extras",permalink:"/docs/category/tutorial---extras"},next:{title:"Translate your site",permalink:"/docs/tutorial-extras/translate-your-site"}},a={},c=[{value:"Create a docs version",id:"create-a-docs-version",level:2},{value:"Add a Version Dropdown",id:"add-a-version-dropdown",level:2},{value:"Update an existing version",id:"update-an-existing-version",level:2}];function l(e){const s={code:"code",h1:"h1",h2:"h2",header:"header",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"manage-docs-versions",children:"Manage Docs Versions"})}),"\n",(0,o.jsx)(s.p,{children:"Docusaurus can manage multiple versions of your docs."}),"\n",(0,o.jsx)(s.h2,{id:"create-a-docs-version",children:"Create a docs version"}),"\n",(0,o.jsx)(s.p,{children:"Release a version 1.0 of your project:"}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-bash",children:"npm run docusaurus docs:version 1.0\n"})}),"\n",(0,o.jsxs)(s.p,{children:["The ",(0,o.jsx)(s.code,{children:"docs"})," folder is copied into ",(0,o.jsx)(s.code,{children:"versioned_docs/version-1.0"})," and ",(0,o.jsx)(s.code,{children:"versions.json"})," is created."]}),"\n",(0,o.jsx)(s.p,{children:"Your docs now have 2 versions:"}),"\n",(0,o.jsxs)(s.ul,{children:["\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"1.0"})," at ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/"})," for the version 1.0 docs"]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"current"})," at ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/next/"})," for the ",(0,o.jsx)(s.strong,{children:"upcoming, unreleased docs"})]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"add-a-version-dropdown",children:"Add a Version Dropdown"}),"\n",(0,o.jsx)(s.p,{children:"To navigate seamlessly across versions, add a version dropdown."}),"\n",(0,o.jsxs)(s.p,{children:["Modify the ",(0,o.jsx)(s.code,{children:"docusaurus.config.js"})," file:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n themeConfig: {\n navbar: {\n items: [\n // highlight-start\n {\n type: 'docsVersionDropdown',\n },\n // highlight-end\n ],\n },\n },\n};\n"})}),"\n",(0,o.jsx)(s.p,{children:"The docs version dropdown appears in your navbar:"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.img,{alt:"Docs Version Dropdown",src:n(6223).A+"",width:"370",height:"302"})}),"\n",(0,o.jsx)(s.h2,{id:"update-an-existing-version",children:"Update an existing version"}),"\n",(0,o.jsx)(s.p,{children:"It is possible to edit versioned docs in their respective folder:"}),"\n",(0,o.jsxs)(s.ul,{children:["\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"versioned_docs/version-1.0/hello.md"})," updates ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/hello"})]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"docs/hello.md"})," updates ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/next/hello"})]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},6223:(e,s,n)=>{n.d(s,{A:()=>o});const o=n.p+"assets/images/docsVersionDropdown-35e13cbe46c9923327f30a76a90bff3b.png"},8453:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>d});var o=n(6540);const r={},i=o.createContext(r);function t(e){const s=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dff1c289.873caedc.js b/assets/js/dff1c289.873caedc.js deleted file mode 100644 index 2bf942012d..0000000000 --- a/assets/js/dff1c289.873caedc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1724],{8043:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var o=n(4848),r=n(8453);const i={sidebar_position:1},t="Manage Docs Versions",d={id:"tutorial-extras/manage-docs-versions",title:"Manage Docs Versions",description:"Docusaurus can manage multiple versions of your docs.",source:"@site/docs/tutorial-extras/manage-docs-versions.md",sourceDirName:"tutorial-extras",slug:"/tutorial-extras/manage-docs-versions",permalink:"/docs/tutorial-extras/manage-docs-versions",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-extras/manage-docs-versions.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Tutorial - Extras",permalink:"/docs/category/tutorial---extras"},next:{title:"Translate your site",permalink:"/docs/tutorial-extras/translate-your-site"}},a={},c=[{value:"Create a docs version",id:"create-a-docs-version",level:2},{value:"Add a Version Dropdown",id:"add-a-version-dropdown",level:2},{value:"Update an existing version",id:"update-an-existing-version",level:2}];function l(e){const s={code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"manage-docs-versions",children:"Manage Docs Versions"}),"\n",(0,o.jsx)(s.p,{children:"Docusaurus can manage multiple versions of your docs."}),"\n",(0,o.jsx)(s.h2,{id:"create-a-docs-version",children:"Create a docs version"}),"\n",(0,o.jsx)(s.p,{children:"Release a version 1.0 of your project:"}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-bash",children:"npm run docusaurus docs:version 1.0\n"})}),"\n",(0,o.jsxs)(s.p,{children:["The ",(0,o.jsx)(s.code,{children:"docs"})," folder is copied into ",(0,o.jsx)(s.code,{children:"versioned_docs/version-1.0"})," and ",(0,o.jsx)(s.code,{children:"versions.json"})," is created."]}),"\n",(0,o.jsx)(s.p,{children:"Your docs now have 2 versions:"}),"\n",(0,o.jsxs)(s.ul,{children:["\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"1.0"})," at ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/"})," for the version 1.0 docs"]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"current"})," at ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/next/"})," for the ",(0,o.jsx)(s.strong,{children:"upcoming, unreleased docs"})]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"add-a-version-dropdown",children:"Add a Version Dropdown"}),"\n",(0,o.jsx)(s.p,{children:"To navigate seamlessly across versions, add a version dropdown."}),"\n",(0,o.jsxs)(s.p,{children:["Modify the ",(0,o.jsx)(s.code,{children:"docusaurus.config.js"})," file:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n themeConfig: {\n navbar: {\n items: [\n // highlight-start\n {\n type: 'docsVersionDropdown',\n },\n // highlight-end\n ],\n },\n },\n};\n"})}),"\n",(0,o.jsx)(s.p,{children:"The docs version dropdown appears in your navbar:"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.img,{alt:"Docs Version Dropdown",src:n(6223).A+"",width:"370",height:"302"})}),"\n",(0,o.jsx)(s.h2,{id:"update-an-existing-version",children:"Update an existing version"}),"\n",(0,o.jsx)(s.p,{children:"It is possible to edit versioned docs in their respective folder:"}),"\n",(0,o.jsxs)(s.ul,{children:["\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"versioned_docs/version-1.0/hello.md"})," updates ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/hello"})]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.code,{children:"docs/hello.md"})," updates ",(0,o.jsx)(s.code,{children:"http://localhost:3000/docs/next/hello"})]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},6223:(e,s,n)=>{n.d(s,{A:()=>o});const o=n.p+"assets/images/docsVersionDropdown-35e13cbe46c9923327f30a76a90bff3b.png"},8453:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>d});var o=n(6540);const r={},i=o.createContext(r);function t(e){const s=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e273c56f.77949400.js b/assets/js/e273c56f.77949400.js deleted file mode 100644 index 20e4acd95a..0000000000 --- a/assets/js/e273c56f.77949400.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9328],{4014:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>n,contentTitle:()=>a,default:()=>m,frontMatter:()=>r,metadata:()=>u,toc:()=>l});var s=o(4848),i=o(8453);const r={slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},a=void 0,u={permalink:"/blog/first-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md",source:"@site/blog/2019-05-28-first-blog-post.md",title:"First Blog Post",description:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet",date:"2019-05-28T00:00:00.000Z",tags:[{inline:!1,label:"Hola",permalink:"/blog/tags/hola",description:"Hola tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.12,hasTruncateMarker:!1,authors:[{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"}],frontMatter:{slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},unlisted:!1,prevItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},n={authorsImageUrls:[void 0]},l=[];function c(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,s.jsx)(e.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})}function m(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(c,{...t})}):c(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>u});var s=o(6540);const i={},r=s.createContext(i);function a(t){const e=s.useContext(r);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function u(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:a(t.components),s.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/e273c56f.ed8c55c1.js b/assets/js/e273c56f.ed8c55c1.js new file mode 100644 index 0000000000..bffe3c6bad --- /dev/null +++ b/assets/js/e273c56f.ed8c55c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9328],{4014:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>n,contentTitle:()=>a,default:()=>m,frontMatter:()=>u,metadata:()=>r,toc:()=>l});var s=o(4848),i=o(8453);const u={slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},a=void 0,r={permalink:"/blog/first-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md",source:"@site/blog/2019-05-28-first-blog-post.md",title:"First Blog Post",description:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet",date:"2019-05-28T00:00:00.000Z",tags:[{inline:!1,label:"Hola",permalink:"/blog/tags/hola",description:"Hola tag description"},{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.12,hasTruncateMarker:!1,authors:[{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png",key:null,page:null}],frontMatter:{slug:"first-blog-post",title:"First Blog Post",authors:{name:"Gao Wei",title:"Docusaurus Core Team",url:"https://github.com/wgao19",image_url:"https://github.com/wgao19.png",imageURL:"https://github.com/wgao19.png"},tags:["hola","docusaurus"]},unlisted:!1,prevItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},n={authorsImageUrls:[void 0]},l=[];function c(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,s.jsx)(e.p,{children:"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"})}function m(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(c,{...t})}):c(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>r});var s=o(6540);const i={},u=s.createContext(i);function a(t){const e=s.useContext(u);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:a(t.components),s.createElement(u.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/e44a2883.8fd63ee4.js b/assets/js/e44a2883.8fd63ee4.js new file mode 100644 index 0000000000..88cf89b90f --- /dev/null +++ b/assets/js/e44a2883.8fd63ee4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4736],{8350:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=t(4848),s=t(8453);const o={sidebar_position:2},a="Translate your site",i={id:"tutorial-extras/translate-your-site",title:"Translate your site",description:"Let's translate docs/intro.md to French.",source:"@site/docs/tutorial-extras/translate-your-site.md",sourceDirName:"tutorial-extras",slug:"/tutorial-extras/translate-your-site",permalink:"/docs/tutorial-extras/translate-your-site",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-extras/translate-your-site.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Manage Docs Versions",permalink:"/docs/tutorial-extras/manage-docs-versions"},next:{title:"Chatwoot integrations",permalink:"/docs/Integrations/chatwoot"}},l={},d=[{value:"Configure i18n",id:"configure-i18n",level:2},{value:"Translate a doc",id:"translate-a-doc",level:2},{value:"Start your localized site",id:"start-your-localized-site",level:2},{value:"Add a Locale Dropdown",id:"add-a-locale-dropdown",level:2},{value:"Build your localized site",id:"build-your-localized-site",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"translate-your-site",children:"Translate your site"})}),"\n",(0,r.jsxs)(n.p,{children:["Let's translate ",(0,r.jsx)(n.code,{children:"docs/intro.md"})," to French."]}),"\n",(0,r.jsx)(n.h2,{id:"configure-i18n",children:"Configure i18n"}),"\n",(0,r.jsxs)(n.p,{children:["Modify ",(0,r.jsx)(n.code,{children:"docusaurus.config.js"})," to add support for the ",(0,r.jsx)(n.code,{children:"fr"})," locale:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n i18n: {\n defaultLocale: 'en',\n locales: ['en', 'fr'],\n },\n};\n"})}),"\n",(0,r.jsx)(n.h2,{id:"translate-a-doc",children:"Translate a doc"}),"\n",(0,r.jsxs)(n.p,{children:["Copy the ",(0,r.jsx)(n.code,{children:"docs/intro.md"})," file to the ",(0,r.jsx)(n.code,{children:"i18n/fr"})," folder:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/\n\ncp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Translate ",(0,r.jsx)(n.code,{children:"i18n/fr/docusaurus-plugin-content-docs/current/intro.md"})," in French."]}),"\n",(0,r.jsx)(n.h2,{id:"start-your-localized-site",children:"Start your localized site"}),"\n",(0,r.jsx)(n.p,{children:"Start your site on the French locale:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"npm run start -- --locale fr\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Your localized site is accessible at ",(0,r.jsx)(n.a,{href:"http://localhost:3000/fr/",children:"http://localhost:3000/fr/"})," and the ",(0,r.jsx)(n.code,{children:"Getting Started"})," page is translated."]}),"\n",(0,r.jsx)(n.admonition,{type:"caution",children:(0,r.jsx)(n.p,{children:"In development, you can only use one locale at a time."})}),"\n",(0,r.jsx)(n.h2,{id:"add-a-locale-dropdown",children:"Add a Locale Dropdown"}),"\n",(0,r.jsx)(n.p,{children:"To navigate seamlessly across languages, add a locale dropdown."}),"\n",(0,r.jsxs)(n.p,{children:["Modify the ",(0,r.jsx)(n.code,{children:"docusaurus.config.js"})," file:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n themeConfig: {\n navbar: {\n items: [\n // highlight-start\n {\n type: 'localeDropdown',\n },\n // highlight-end\n ],\n },\n },\n};\n"})}),"\n",(0,r.jsx)(n.p,{children:"The locale dropdown now appears in your navbar:"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{alt:"Locale Dropdown",src:t(9722).A+"",width:"370",height:"302"})}),"\n",(0,r.jsx)(n.h2,{id:"build-your-localized-site",children:"Build your localized site"}),"\n",(0,r.jsx)(n.p,{children:"Build your site for a specific locale:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"npm run build -- --locale fr\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or build your site to include all the locales at once:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"npm run build\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},9722:(e,n,t)=>{t.d(n,{A:()=>r});const r=t.p+"assets/images/localeDropdown-f0d995e751e7656a1b0dbbc1134e49c2.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>i});var r=t(6540);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e44a2883.ca938216.js b/assets/js/e44a2883.ca938216.js deleted file mode 100644 index 38ba0c3d52..0000000000 --- a/assets/js/e44a2883.ca938216.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4736],{8350:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var s=t(4848),r=t(8453);const o={sidebar_position:2},a="Translate your site",i={id:"tutorial-extras/translate-your-site",title:"Translate your site",description:"Let's translate docs/intro.md to French.",source:"@site/docs/tutorial-extras/translate-your-site.md",sourceDirName:"tutorial-extras",slug:"/tutorial-extras/translate-your-site",permalink:"/docs/tutorial-extras/translate-your-site",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-extras/translate-your-site.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Manage Docs Versions",permalink:"/docs/tutorial-extras/manage-docs-versions"},next:{title:"Chatwoot integrations",permalink:"/docs/Integrations/chatwoot"}},l={},c=[{value:"Configure i18n",id:"configure-i18n",level:2},{value:"Translate a doc",id:"translate-a-doc",level:2},{value:"Start your localized site",id:"start-your-localized-site",level:2},{value:"Add a Locale Dropdown",id:"add-a-locale-dropdown",level:2},{value:"Build your localized site",id:"build-your-localized-site",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",img:"img",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"translate-your-site",children:"Translate your site"}),"\n",(0,s.jsxs)(n.p,{children:["Let's translate ",(0,s.jsx)(n.code,{children:"docs/intro.md"})," to French."]}),"\n",(0,s.jsx)(n.h2,{id:"configure-i18n",children:"Configure i18n"}),"\n",(0,s.jsxs)(n.p,{children:["Modify ",(0,s.jsx)(n.code,{children:"docusaurus.config.js"})," to add support for the ",(0,s.jsx)(n.code,{children:"fr"})," locale:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n i18n: {\n defaultLocale: 'en',\n locales: ['en', 'fr'],\n },\n};\n"})}),"\n",(0,s.jsx)(n.h2,{id:"translate-a-doc",children:"Translate a doc"}),"\n",(0,s.jsxs)(n.p,{children:["Copy the ",(0,s.jsx)(n.code,{children:"docs/intro.md"})," file to the ",(0,s.jsx)(n.code,{children:"i18n/fr"})," folder:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/\n\ncp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Translate ",(0,s.jsx)(n.code,{children:"i18n/fr/docusaurus-plugin-content-docs/current/intro.md"})," in French."]}),"\n",(0,s.jsx)(n.h2,{id:"start-your-localized-site",children:"Start your localized site"}),"\n",(0,s.jsx)(n.p,{children:"Start your site on the French locale:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run start -- --locale fr\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Your localized site is accessible at ",(0,s.jsx)(n.a,{href:"http://localhost:3000/fr/",children:"http://localhost:3000/fr/"})," and the ",(0,s.jsx)(n.code,{children:"Getting Started"})," page is translated."]}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsx)(n.p,{children:"In development, you can only use one locale at a time."})}),"\n",(0,s.jsx)(n.h2,{id:"add-a-locale-dropdown",children:"Add a Locale Dropdown"}),"\n",(0,s.jsx)(n.p,{children:"To navigate seamlessly across languages, add a locale dropdown."}),"\n",(0,s.jsxs)(n.p,{children:["Modify the ",(0,s.jsx)(n.code,{children:"docusaurus.config.js"})," file:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:"export default {\n themeConfig: {\n navbar: {\n items: [\n // highlight-start\n {\n type: 'localeDropdown',\n },\n // highlight-end\n ],\n },\n },\n};\n"})}),"\n",(0,s.jsx)(n.p,{children:"The locale dropdown now appears in your navbar:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Locale Dropdown",src:t(9722).A+"",width:"370",height:"302"})}),"\n",(0,s.jsx)(n.h2,{id:"build-your-localized-site",children:"Build your localized site"}),"\n",(0,s.jsx)(n.p,{children:"Build your site for a specific locale:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run build -- --locale fr\n"})}),"\n",(0,s.jsx)(n.p,{children:"Or build your site to include all the locales at once:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run build\n"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},9722:(e,n,t)=>{t.d(n,{A:()=>s});const s=t.p+"assets/images/localeDropdown-f0d995e751e7656a1b0dbbc1134e49c2.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>i});var s=t(6540);const r={},o=s.createContext(r);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e541f69e.da42c374.js b/assets/js/e541f69e.da42c374.js deleted file mode 100644 index 0ac367bd71..0000000000 --- a/assets/js/e541f69e.da42c374.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8394],{3688:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>c,toc:()=>t});var i=n(4848),l=n(8453);const d={},r="Interface: Message",c={id:"reference/api/model/message/interfaces/Message",title:"Interface: Message",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/Message.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/Message",permalink:"/docs/reference/api/model/message/interfaces/Message",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/Message.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes"},next:{title:"Interface: MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"ack",id:"ack",level:3},{value:"author",id:"author",level:3},{value:"body",id:"body",level:3},{value:"broadcast",id:"broadcast",level:3},{value:"buttons?",id:"buttons",level:3},{value:"caption",id:"caption",level:3},{value:"chat",id:"chat",level:3},{value:"chatId",id:"chatid",level:3},{value:"clientUrl",id:"clienturl",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"cloudUrl?",id:"cloudurl",level:3},{value:"content",id:"content",level:3},{value:"ctwaContext?",id:"ctwacontext",level:3},{value:"isSuspiciousLink",id:"issuspiciouslink",level:4},{value:"mediaType",id:"mediatype",level:4},{value:"sourceUrl",id:"sourceurl",level:4},{value:"thumbnail",id:"thumbnail",level:4},{value:"deprecatedMms3Url",id:"deprecatedmms3url",level:3},{value:"device",id:"device",level:3},{value:"duration?",id:"duration",level:3},{value:"filePath?",id:"filepath",level:3},{value:"filehash?",id:"filehash",level:3},{value:"filename?",id:"filename",level:3},{value:"from",id:"from",level:3},{value:"fromMe",id:"fromme",level:3},{value:"id",id:"id",level:3},{value:"invis",id:"invis",level:3},{value:"isAnimated",id:"isanimated",level:3},{value:"isForwarded",id:"isforwarded",level:3},{value:"isGroupJoinRequest?",id:"isgroupjoinrequest",level:3},{value:"isGroupMsg",id:"isgroupmsg",level:3},{value:"isMMS",id:"ismms",level:3},{value:"isMedia",id:"ismedia",level:3},{value:"isNewMsg",id:"isnewmsg",level:3},{value:"isNotification",id:"isnotification",level:3},{value:"isPSA",id:"ispsa",level:3},{value:"isQuotedMsgAvailable",id:"isquotedmsgavailable",level:3},{value:"isViewOnce",id:"isviewonce",level:3},{value:"labels",id:"labels",level:3},{value:"lat?",id:"lat",level:3},{value:"list?",id:"list",level:3},{value:"buttonText",id:"buttontext",level:4},{value:"description",id:"description",level:4},{value:"sections",id:"sections",level:4},{value:"title",id:"title",level:4},{value:"listResponse?",id:"listresponse",level:3},{value:"lng?",id:"lng",level:3},{value:"loc?",id:"loc",level:3},{value:"local",id:"local",level:3},{value:"mId",id:"mid",level:3},{value:"mediaData",id:"mediadata",level:3},{value:"mentionedJidList",id:"mentionedjidlist",level:3},{value:"mimetype?",id:"mimetype",level:3},{value:"notifyName",id:"notifyname",level:3},{value:"pollOptions?",id:"polloptions",level:3},{value:"quoteMap",id:"quotemap",level:3},{value:"quotedMsg?",id:"quotedmsg",level:3},{value:"quotedMsgObj?",id:"quotedmsgobj",level:3},{value:"quotedParentGroupJid?",id:"quotedparentgroupjid",level:3},{value:"quotedRemoteJid?",id:"quotedremotejid",level:3},{value:"reactionByMe?",id:"reactionbyme",level:3},{value:"reactions",id:"reactions",level:3},{value:"recvFresh",id:"recvfresh",level:3},{value:"selectedButtonId",id:"selectedbuttonid",level:3},{value:"self",id:"self",level:3},{value:"sender",id:"sender",level:3},{value:"senderId?",id:"senderid",level:3},{value:"shareDuration",id:"shareduration",level:3},{value:"star",id:"star",level:3},{value:"stickerAuthor?",id:"stickerauthor",level:3},{value:"stickerPack?",id:"stickerpack",level:3},{value:"t",id:"t",level:3},{value:"text",id:"text",level:3},{value:"timestamp",id:"timestamp",level:3},{value:"to",id:"to",level:3},{value:"type",id:"type",level:3}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-message",children:"Interface: Message"}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ack",children:"ack"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"ack"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:(0,i.jsx)(s.code,{children:"MessageAck"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The acknolwedgement state of a message [[MessageAck]]"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"author",children:"author"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"author"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"body",children:"body"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"body"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["The body of the message. If the message type is ",(0,i.jsx)(s.code,{children:"chat"})," , ",(0,i.jsx)(s.code,{children:"body"})," will be the text of the chat. If the message type is some sort of media, then this body will be the thumbnail of the media."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"broadcast",children:"broadcast"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"broadcast"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is sent as a broadcast"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"buttons",children:"buttons?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"buttons"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,i.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Buttons associated with the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"caption",children:"caption"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"caption"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is of a media type, it may also have a caption"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"chat",children:"chat"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"chat"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,i.jsx)(s.code,{children:"Chat"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat object"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"chatid",children:"chatId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"chatId"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"clienturl",children:(0,i.jsx)(s.del,{children:"clientUrl"})}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"clientUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(s.p,{children:["Ironically, you should be using ",(0,i.jsx)(s.code,{children:"deprecatedMms3Url"})," instead"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"cloudurl",children:"cloudUrl?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"cloudUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The URL of the file after being uploaded to the cloud using a cloud upload message preprocessor."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"content",children:"content"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"content"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ctwacontext",children:"ctwaContext?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"ctwaContext"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"issuspiciouslink",children:"isSuspiciousLink"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isSuspiciousLink"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"mediatype",children:"mediaType"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mediaType"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"sourceurl",children:"sourceUrl"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sourceUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"thumbnail",children:"thumbnail"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"thumbnail"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"deprecatedmms3url",children:"deprecatedMms3Url"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"deprecatedMms3Url"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"device",children:"device"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"device"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The device ID of the device that sent the message. This is only present if the message was sent from host account-linked session. This is useful for determining if a message was sent from a different mobile device (note that whenever a device) or a desktop session."}),"\n",(0,i.jsxs)(s.p,{children:["Note: This will emit a number for the current controlled session also but the only way to know if the number represents the current session is by checking ",(0,i.jsx)(s.code,{children:"local"})," (it will be ",(0,i.jsx)(s.code,{children:"true"})," if the message was sent from the current session)."]}),"\n",(0,i.jsxs)(s.p,{children:["If the device ID is ",(0,i.jsx)(s.code,{children:"0"}),' then the message was sent from the "root" host account device.']}),"\n",(0,i.jsx)(s.p,{children:"This might be undefined for incoming messages."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"duration",children:"duration?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"duration"}),": ",(0,i.jsx)(s.code,{children:"string"})," | ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The length of the media in the message, if it exists."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filepath",children:"filePath?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filePath"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["When ",(0,i.jsx)(s.code,{children:'config.messagePreprocessor: "AUTO_DECRYPT_SAVE"'})," is set, media is decrypted and saved on disk in a folder called media relative to the current working directory."]}),"\n",(0,i.jsx)(s.p,{children:"This is the filePath of the decrypted file."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filehash",children:"filehash?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filehash"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Used to checking the integrity of the decrypted media."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filename",children:"filename?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filename"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The given filename of the file"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"from",children:"from"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"from"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat from which the message was sent"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"fromme",children:"fromMe"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"fromMe"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is from the host account"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,i.jsx)(s.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The id of the message. Consists of the Chat ID and a unique string."}),"\n",(0,i.jsx)(s.p,{children:"Example:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{children:"false_447123456789@c.us_7D914FEA78BE10277743F4B785045C37\n"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"invis",children:"invis"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"invis"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isanimated",children:"isAnimated"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isAnimated"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isforwarded",children:"isForwarded"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isForwarded"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message has been forwarded"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isgroupjoinrequest",children:"isGroupJoinRequest?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"isGroupJoinRequest"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"When a user requests to join a group wihtin a community the request is received by the host as a message. This boolean will allow you to easily determine if the incoming message is a request to join a group."}),"\n",(0,i.jsxs)(s.p,{children:["If this is ",(0,i.jsx)(s.code,{children:"true"})," then you need to determine within your own code whether or not to accept the user to the group which is indicated with ",(0,i.jsx)(s.code,{children:"quotedRemoteJid"})," using ",(0,i.jsx)(s.code,{children:"addParticipant"}),"."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isgroupmsg",children:"isGroupMsg"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isGroupMsg"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ismms",children:"isMMS"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isMMS"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ismedia",children:"isMedia"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isMedia"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isnewmsg",children:"isNewMsg"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isNewMsg"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isnotification",children:"isNotification"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isNotification"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ispsa",children:"isPSA"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isPSA"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isquotedmsgavailable",children:"isQuotedMsgAvailable"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isQuotedMsgAvailable"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If this message is quoting (replying to) another message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isviewonce",children:"isViewOnce"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isViewOnce"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:'Is the message a "view once" message'}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"labels"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The labels associated with the message (used with business accounts)"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"lat",children:"lat?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"lat"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The latitude of a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"list",children:"list?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"list"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The list associated with the list message"}),"\n",(0,i.jsx)(s.h4,{id:"buttontext",children:"buttonText"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"buttonText"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"description",children:"description"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"description"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"sections",children:"sections"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sections"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,i.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"title",children:"title"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"title"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"listresponse",children:"listResponse?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"listResponse"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:(0,i.jsx)(s.code,{children:"Row"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"List response associated with the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"lng",children:"lng?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"lng"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The longitude of a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"loc",children:"loc?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"loc"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The text associated with a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"local",children:"local"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"local"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["If the message was sent from this controlled session this will be ",(0,i.jsx)(s.code,{children:"true"}),". This is useful for determining if a message was sent from a different mobile device (note that whenever a device) or a desktop session."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mid",children:"mId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The unique segment of the message id."}),"\n",(0,i.jsx)(s.p,{children:"Example:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{children:"7D914FEA78BE10277743F4B785045C37\n"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mediadata",children:"mediaData"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mediaData"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mentionedjidlist",children:"mentionedJidList"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mentionedJidList"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"An array of all mentioned numbers in this message."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mimetype",children:"mimetype?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"mimetype"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"notifyname",children:"notifyName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"notifyName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"polloptions",children:"pollOptions?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"pollOptions"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,i.jsx)(s.code,{children:"PollOption"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The options of a poll"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotemap",children:"quoteMap"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"quoteMap"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:(0,i.jsx)(s.code,{children:"QuoteMap"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Use this to traverse the quote chain."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedmsg",children:"quotedMsg?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedMsg"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedmsgobj",children:"quotedMsgObj?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedMsgObj"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedparentgroupjid",children:"quotedParentGroupJid?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedParentGroupJid"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by ",(0,i.jsx)(s.code,{children:"quotedRemoteJid"})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedremotejid",children:"quotedRemoteJid?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedRemoteJid"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the quoted group. Usually present when a user is requesting to join a group."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"reactionbyme",children:"reactionByMe?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"reactionByMe"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:(0,i.jsx)(s.code,{children:"ReactionSender"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The reaction of the host account to this message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"reactions",children:"reactions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"reactions"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"recvfresh",children:"recvFresh"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"recvFresh"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"selectedbuttonid",children:"selectedButtonId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"selectedButtonId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the selected button"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"self",children:"self"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"self"}),": ",(0,i.jsx)(s.code,{children:'"in"'})," | ",(0,i.jsx)(s.code,{children:'"out"'})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["Indicates whether the message is coming into the session or going out of the session. You can have a message sent by the host account show as ",(0,i.jsx)(s.code,{children:"in"})," when the message was sent from another\nsession or from the host account device itself."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"sender",children:"sender"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sender"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(s.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The contact object of the account that sent the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"senderid",children:"senderId?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"senderId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the message sender"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"shareduration",children:"shareDuration"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"shareDuration"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"star",children:"star"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"star"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"stickerauthor",children:"stickerAuthor?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"stickerAuthor"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"stickerpack",children:"stickerPack?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"stickerPack"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"t"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The timestamp of the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"text",children:"text"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"text"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"a convenient way to get the main text content from a message."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"timestamp"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"the timestanmp of the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"to",children:"to"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"to"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat id to which the message is being sent"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"type",children:"type"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"type"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:(0,i.jsx)(s.code,{children:"MessageTypes"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The type of the message, see [[MessageTypes]]"})]})}function a(e={}){const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>c});var i=n(6540);const l={},d=i.createContext(l);function r(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e541f69e.fcea3fbe.js b/assets/js/e541f69e.fcea3fbe.js new file mode 100644 index 0000000000..5fb02f8ff4 --- /dev/null +++ b/assets/js/e541f69e.fcea3fbe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8394],{3688:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>c,toc:()=>t});var i=n(4848),l=n(8453);const d={},r="Interface: Message",c={id:"reference/api/model/message/interfaces/Message",title:"Interface: Message",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/Message.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/Message",permalink:"/docs/reference/api/model/message/interfaces/Message",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/Message.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes"},next:{title:"Interface: MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"ack",id:"ack",level:3},{value:"author",id:"author",level:3},{value:"body",id:"body",level:3},{value:"broadcast",id:"broadcast",level:3},{value:"buttons?",id:"buttons",level:3},{value:"caption",id:"caption",level:3},{value:"chat",id:"chat",level:3},{value:"chatId",id:"chatid",level:3},{value:"clientUrl",id:"clienturl",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"cloudUrl?",id:"cloudurl",level:3},{value:"content",id:"content",level:3},{value:"ctwaContext?",id:"ctwacontext",level:3},{value:"isSuspiciousLink",id:"issuspiciouslink",level:4},{value:"mediaType",id:"mediatype",level:4},{value:"sourceUrl",id:"sourceurl",level:4},{value:"thumbnail",id:"thumbnail",level:4},{value:"deprecatedMms3Url",id:"deprecatedmms3url",level:3},{value:"device",id:"device",level:3},{value:"duration?",id:"duration",level:3},{value:"filePath?",id:"filepath",level:3},{value:"filehash?",id:"filehash",level:3},{value:"filename?",id:"filename",level:3},{value:"from",id:"from",level:3},{value:"fromMe",id:"fromme",level:3},{value:"id",id:"id",level:3},{value:"invis",id:"invis",level:3},{value:"isAnimated",id:"isanimated",level:3},{value:"isForwarded",id:"isforwarded",level:3},{value:"isGroupJoinRequest?",id:"isgroupjoinrequest",level:3},{value:"isGroupMsg",id:"isgroupmsg",level:3},{value:"isMMS",id:"ismms",level:3},{value:"isMedia",id:"ismedia",level:3},{value:"isNewMsg",id:"isnewmsg",level:3},{value:"isNotification",id:"isnotification",level:3},{value:"isPSA",id:"ispsa",level:3},{value:"isQuotedMsgAvailable",id:"isquotedmsgavailable",level:3},{value:"isViewOnce",id:"isviewonce",level:3},{value:"labels",id:"labels",level:3},{value:"lat?",id:"lat",level:3},{value:"list?",id:"list",level:3},{value:"buttonText",id:"buttontext",level:4},{value:"description",id:"description",level:4},{value:"sections",id:"sections",level:4},{value:"title",id:"title",level:4},{value:"listResponse?",id:"listresponse",level:3},{value:"lng?",id:"lng",level:3},{value:"loc?",id:"loc",level:3},{value:"local",id:"local",level:3},{value:"mId",id:"mid",level:3},{value:"mediaData",id:"mediadata",level:3},{value:"mentionedJidList",id:"mentionedjidlist",level:3},{value:"mimetype?",id:"mimetype",level:3},{value:"notifyName",id:"notifyname",level:3},{value:"pollOptions?",id:"polloptions",level:3},{value:"quoteMap",id:"quotemap",level:3},{value:"quotedMsg?",id:"quotedmsg",level:3},{value:"quotedMsgObj?",id:"quotedmsgobj",level:3},{value:"quotedParentGroupJid?",id:"quotedparentgroupjid",level:3},{value:"quotedRemoteJid?",id:"quotedremotejid",level:3},{value:"reactionByMe?",id:"reactionbyme",level:3},{value:"reactions",id:"reactions",level:3},{value:"recvFresh",id:"recvfresh",level:3},{value:"selectedButtonId",id:"selectedbuttonid",level:3},{value:"self",id:"self",level:3},{value:"sender",id:"sender",level:3},{value:"senderId?",id:"senderid",level:3},{value:"shareDuration",id:"shareduration",level:3},{value:"star",id:"star",level:3},{value:"stickerAuthor?",id:"stickerauthor",level:3},{value:"stickerPack?",id:"stickerpack",level:3},{value:"t",id:"t",level:3},{value:"text",id:"text",level:3},{value:"timestamp",id:"timestamp",level:3},{value:"to",id:"to",level:3},{value:"type",id:"type",level:3}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"interface-message",children:"Interface: Message"})}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ack",children:"ack"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"ack"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:(0,i.jsx)(s.code,{children:"MessageAck"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The acknolwedgement state of a message [[MessageAck]]"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"author",children:"author"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"author"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"body",children:"body"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"body"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["The body of the message. If the message type is ",(0,i.jsx)(s.code,{children:"chat"})," , ",(0,i.jsx)(s.code,{children:"body"})," will be the text of the chat. If the message type is some sort of media, then this body will be the thumbnail of the media."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"broadcast",children:"broadcast"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"broadcast"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is sent as a broadcast"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"buttons",children:"buttons?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"buttons"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,i.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Buttons associated with the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"caption",children:"caption"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"caption"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is of a media type, it may also have a caption"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"chat",children:"chat"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"chat"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,i.jsx)(s.code,{children:"Chat"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat object"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"chatid",children:"chatId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"chatId"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"clienturl",children:(0,i.jsx)(s.del,{children:"clientUrl"})}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"clientUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(s.p,{children:["Ironically, you should be using ",(0,i.jsx)(s.code,{children:"deprecatedMms3Url"})," instead"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"cloudurl",children:"cloudUrl?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"cloudUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The URL of the file after being uploaded to the cloud using a cloud upload message preprocessor."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"content",children:"content"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"content"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ctwacontext",children:"ctwaContext?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"ctwaContext"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"issuspiciouslink",children:"isSuspiciousLink"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isSuspiciousLink"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"mediatype",children:"mediaType"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mediaType"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"sourceurl",children:"sourceUrl"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sourceUrl"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"thumbnail",children:"thumbnail"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"thumbnail"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"deprecatedmms3url",children:"deprecatedMms3Url"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"deprecatedMms3Url"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"device",children:"device"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"device"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The device ID of the device that sent the message. This is only present if the message was sent from host account-linked session. This is useful for determining if a message was sent from a different mobile device (note that whenever a device) or a desktop session."}),"\n",(0,i.jsxs)(s.p,{children:["Note: This will emit a number for the current controlled session also but the only way to know if the number represents the current session is by checking ",(0,i.jsx)(s.code,{children:"local"})," (it will be ",(0,i.jsx)(s.code,{children:"true"})," if the message was sent from the current session)."]}),"\n",(0,i.jsxs)(s.p,{children:["If the device ID is ",(0,i.jsx)(s.code,{children:"0"}),' then the message was sent from the "root" host account device.']}),"\n",(0,i.jsx)(s.p,{children:"This might be undefined for incoming messages."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"duration",children:"duration?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"duration"}),": ",(0,i.jsx)(s.code,{children:"string"})," | ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The length of the media in the message, if it exists."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filepath",children:"filePath?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filePath"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["When ",(0,i.jsx)(s.code,{children:'config.messagePreprocessor: "AUTO_DECRYPT_SAVE"'})," is set, media is decrypted and saved on disk in a folder called media relative to the current working directory."]}),"\n",(0,i.jsx)(s.p,{children:"This is the filePath of the decrypted file."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filehash",children:"filehash?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filehash"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Used to checking the integrity of the decrypted media."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"filename",children:"filename?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"filename"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The given filename of the file"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"from",children:"from"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"from"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat from which the message was sent"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"fromme",children:"fromMe"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"fromMe"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message is from the host account"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,i.jsx)(s.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The id of the message. Consists of the Chat ID and a unique string."}),"\n",(0,i.jsx)(s.p,{children:"Example:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{children:"false_447123456789@c.us_7D914FEA78BE10277743F4B785045C37\n"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"invis",children:"invis"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"invis"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isanimated",children:"isAnimated"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isAnimated"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isforwarded",children:"isForwarded"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isForwarded"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If the message has been forwarded"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isgroupjoinrequest",children:"isGroupJoinRequest?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"isGroupJoinRequest"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"When a user requests to join a group wihtin a community the request is received by the host as a message. This boolean will allow you to easily determine if the incoming message is a request to join a group."}),"\n",(0,i.jsxs)(s.p,{children:["If this is ",(0,i.jsx)(s.code,{children:"true"})," then you need to determine within your own code whether or not to accept the user to the group which is indicated with ",(0,i.jsx)(s.code,{children:"quotedRemoteJid"})," using ",(0,i.jsx)(s.code,{children:"addParticipant"}),"."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isgroupmsg",children:"isGroupMsg"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isGroupMsg"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ismms",children:"isMMS"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isMMS"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ismedia",children:"isMedia"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isMedia"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isnewmsg",children:"isNewMsg"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isNewMsg"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isnotification",children:"isNotification"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isNotification"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ispsa",children:"isPSA"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isPSA"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isquotedmsgavailable",children:"isQuotedMsgAvailable"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isQuotedMsgAvailable"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"If this message is quoting (replying to) another message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"isviewonce",children:"isViewOnce"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"isViewOnce"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:'Is the message a "view once" message'}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"labels",children:"labels"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"labels"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The labels associated with the message (used with business accounts)"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"lat",children:"lat?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"lat"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The latitude of a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"list",children:"list?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"list"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The list associated with the list message"}),"\n",(0,i.jsx)(s.h4,{id:"buttontext",children:"buttonText"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"buttonText"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"description",children:"description"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"description"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"sections",children:"sections"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sections"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,i.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"title",children:"title"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"title"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"listresponse",children:"listResponse?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"listResponse"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Row",children:(0,i.jsx)(s.code,{children:"Row"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"List response associated with the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"lng",children:"lng?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"lng"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The longitude of a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"loc",children:"loc?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"loc"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The text associated with a location message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"local",children:"local"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"local"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["If the message was sent from this controlled session this will be ",(0,i.jsx)(s.code,{children:"true"}),". This is useful for determining if a message was sent from a different mobile device (note that whenever a device) or a desktop session."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mid",children:"mId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The unique segment of the message id."}),"\n",(0,i.jsx)(s.p,{children:"Example:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{children:"7D914FEA78BE10277743F4B785045C37\n"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mediadata",children:"mediaData"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mediaData"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mentionedjidlist",children:"mentionedJidList"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"mentionedJidList"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,i.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"An array of all mentioned numbers in this message."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"mimetype",children:"mimetype?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"mimetype"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"notifyname",children:"notifyName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"notifyName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"polloptions",children:"pollOptions?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"pollOptions"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:(0,i.jsx)(s.code,{children:"PollOption"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The options of a poll"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotemap",children:"quoteMap"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"quoteMap"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:(0,i.jsx)(s.code,{children:"QuoteMap"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Use this to traverse the quote chain."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedmsg",children:"quotedMsg?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedMsg"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedmsgobj",children:"quotedMsgObj?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedMsgObj"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,i.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedparentgroupjid",children:"quotedParentGroupJid?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedParentGroupJid"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,i.jsx)(s.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by ",(0,i.jsx)(s.code,{children:"quotedRemoteJid"})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"quotedremotejid",children:"quotedRemoteJid?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"quotedRemoteJid"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the quoted group. Usually present when a user is requesting to join a group."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"reactionbyme",children:"reactionByMe?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"reactionByMe"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:(0,i.jsx)(s.code,{children:"ReactionSender"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The reaction of the host account to this message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"reactions",children:"reactions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"reactions"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"recvfresh",children:"recvFresh"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"recvFresh"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"selectedbuttonid",children:"selectedButtonId"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"selectedButtonId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the selected button"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"self",children:"self"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"self"}),": ",(0,i.jsx)(s.code,{children:'"in"'})," | ",(0,i.jsx)(s.code,{children:'"out"'})]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["Indicates whether the message is coming into the session or going out of the session. You can have a message sent by the host account show as ",(0,i.jsx)(s.code,{children:"in"})," when the message was sent from another\nsession or from the host account device itself."]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"sender",children:"sender"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"sender"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,i.jsx)(s.code,{children:"Contact"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The contact object of the account that sent the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"senderid",children:"senderId?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"senderId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The ID of the message sender"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"shareduration",children:"shareDuration"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"shareDuration"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"star",children:"star"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"star"}),": ",(0,i.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"stickerauthor",children:"stickerAuthor?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"stickerAuthor"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"stickerpack",children:"stickerPack?"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"optional"})," ",(0,i.jsx)(s.strong,{children:"stickerPack"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"t",children:"t"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"t"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The timestamp of the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"text",children:"text"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"text"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"a convenient way to get the main text content from a message."}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"timestamp"}),": ",(0,i.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"the timestanmp of the message"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"to",children:"to"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"to"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,i.jsx)(s.code,{children:"ChatId"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The chat id to which the message is being sent"}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"type",children:"type"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"type"}),": ",(0,i.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:(0,i.jsx)(s.code,{children:"MessageTypes"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"The type of the message, see [[MessageTypes]]"})]})}function a(e={}){const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>c});var i=n(6540);const l={},d=i.createContext(l);function r(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e60aee91.7636ffe2.js b/assets/js/e60aee91.7636ffe2.js deleted file mode 100644 index ebc23c1ba9..0000000000 --- a/assets/js/e60aee91.7636ffe2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5003],{5782:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var n=s(4848),i=s(8453);const c={},d="Class: SessionExpiredError",t={id:"reference/api/model/errors/classes/SessionExpiredError",title:"Class: SessionExpiredError",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/SessionExpiredError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/SessionExpiredError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout"},next:{title:"Enumeration: AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new SessionExpiredError()",id:"new-sessionexpirederror",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"class-sessionexpirederror",children:"Class: SessionExpiredError"}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-sessionexpirederror",children:"new SessionExpiredError()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new SessionExpiredError"}),"(): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:(0,n.jsx)(r.code,{children:"SessionExpiredError"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:(0,n.jsx)(r.code,{children:"SessionExpiredError"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>d,x:()=>t});var n=s(6540);const i={},c=n.createContext(i);function d(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e60aee91.d19463e9.js b/assets/js/e60aee91.d19463e9.js new file mode 100644 index 0000000000..f756347a5b --- /dev/null +++ b/assets/js/e60aee91.d19463e9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5003],{5782:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var n=s(4848),i=s(8453);const c={},d="Class: SessionExpiredError",t={id:"reference/api/model/errors/classes/SessionExpiredError",title:"Class: SessionExpiredError",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/SessionExpiredError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/SessionExpiredError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout"},next:{title:"Enumeration: AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new SessionExpiredError()",id:"new-sessionexpirederror",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"class-sessionexpirederror",children:"Class: SessionExpiredError"})}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-sessionexpirederror",children:"new SessionExpiredError()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new SessionExpiredError"}),"(): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:(0,n.jsx)(r.code,{children:"SessionExpiredError"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:(0,n.jsx)(r.code,{children:"SessionExpiredError"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>d,x:()=>t});var n=s(6540);const i={},c=n.createContext(i);function d(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ea673145.33c6e5b1.js b/assets/js/ea673145.33c6e5b1.js deleted file mode 100644 index 33f5f2249d..0000000000 --- a/assets/js/ea673145.33c6e5b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2081],{1163:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var t=i(4848),s=i(8453);const c={},o="Type Alias: Reaction",r={id:"reference/api/model/reactions/type-aliases/Reaction",title:"Type Alias: Reaction",description:"Reaction: object",source:"@site/docs/reference/api/model/reactions/type-aliases/Reaction.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/Reaction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/reactions",permalink:"/docs/reference/api/model/reactions/"},next:{title:"Type Alias: ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent"}},a={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"aggregateEmoji",id:"aggregateemoji",level:3},{value:"hasReactionByMe",id:"hasreactionbyme",level:3},{value:"id",id:"id",level:3},{value:"senders",id:"senders",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-reaction",children:"Type Alias: Reaction"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Reaction"}),": ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A reaction is identified the specific emoji."}),"\n",(0,t.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,t.jsx)(n.h3,{id:"aggregateemoji",children:"aggregateEmoji"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"aggregateEmoji"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The aggregate emoji used for the reaction."}),"\n",(0,t.jsx)(n.h3,{id:"hasreactionbyme",children:"hasReactionByMe"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"hasReactionByMe"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"If the reaction is also sent by the host account"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The identifier of the reaction"}),"\n",(0,t.jsx)(n.h3,{id:"senders",children:"senders"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"senders"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:(0,t.jsx)(n.code,{children:"ReactionRecord"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The senders of this spefcific reaction"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var t=i(6540);const s={},c=t.createContext(s);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ea673145.679a643c.js b/assets/js/ea673145.679a643c.js new file mode 100644 index 0000000000..fd2ffce618 --- /dev/null +++ b/assets/js/ea673145.679a643c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2081],{1163:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(4848),s=i(8453);const r={},c="Type Alias: Reaction",o={id:"reference/api/model/reactions/type-aliases/Reaction",title:"Type Alias: Reaction",description:"Reaction: object",source:"@site/docs/reference/api/model/reactions/type-aliases/Reaction.md",sourceDirName:"reference/api/model/reactions/type-aliases",slug:"/reference/api/model/reactions/type-aliases/Reaction",permalink:"/docs/reference/api/model/reactions/type-aliases/Reaction",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/reactions/type-aliases/Reaction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/reactions",permalink:"/docs/reference/api/model/reactions/"},next:{title:"Type Alias: ReactionEvent",permalink:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent"}},a={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"aggregateEmoji",id:"aggregateemoji",level:3},{value:"hasReactionByMe",id:"hasreactionbyme",level:3},{value:"id",id:"id",level:3},{value:"senders",id:"senders",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"type-alias-reaction",children:"Type Alias: Reaction"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Reaction"}),": ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A reaction is identified the specific emoji."}),"\n",(0,t.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,t.jsx)(n.h3,{id:"aggregateemoji",children:"aggregateEmoji"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"aggregateEmoji"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The aggregate emoji used for the reaction."}),"\n",(0,t.jsx)(n.h3,{id:"hasreactionbyme",children:"hasReactionByMe"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"hasReactionByMe"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"If the reaction is also sent by the host account"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The identifier of the reaction"}),"\n",(0,t.jsx)(n.h3,{id:"senders",children:"senders"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"senders"}),": ",(0,t.jsx)(n.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:(0,t.jsx)(n.code,{children:"ReactionRecord"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The senders of this spefcific reaction"})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(6540);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eaab7dd2.75a458ed.js b/assets/js/eaab7dd2.75a458ed.js new file mode 100644 index 0000000000..bbcb84b9c2 --- /dev/null +++ b/assets/js/eaab7dd2.75a458ed.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5451],{8839:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>l,metadata:()=>n,toc:()=>a});var s=t(4848),o=t(8453);const l={},c="Type Alias: CollectorFilter()",n={id:"reference/structures/Collector/type-aliases/CollectorFilter",title:"Type Alias: CollectorFilter()\\",description:"CollectorFilter\\: (...args) => boolean \\| Promise\\",source:"@site/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",sourceDirName:"reference/structures/Collector/type-aliases",slug:"/reference/structures/Collector/type-aliases/CollectorFilter",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions"},next:{title:"structures/Dialog",permalink:"/docs/reference/structures/Dialog/"}},i={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const r={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"type-alias-collectorfiltert",children:"Type Alias: CollectorFilter()"})}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"CollectorFilter"}),"<",(0,s.jsx)(r.code,{children:"T"}),">: (...",(0,s.jsx)(r.code,{children:"args"}),") => ",(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," ",(0,s.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ...",(0,s.jsx)(r.strong,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"T"})]}),"\n",(0,s.jsx)(r.p,{children:"Any arguments received by the listener"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>n});var s=t(6540);const o={},l=s.createContext(o);function c(e){const r=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function n(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(l.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eaab7dd2.9ca44b96.js b/assets/js/eaab7dd2.9ca44b96.js deleted file mode 100644 index 947515310e..0000000000 --- a/assets/js/eaab7dd2.9ca44b96.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5451],{8839:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>l,metadata:()=>n,toc:()=>a});var s=t(4848),o=t(8453);const l={},c="Type Alias: CollectorFilter()",n={id:"reference/structures/Collector/type-aliases/CollectorFilter",title:"Type Alias: CollectorFilter()\\",description:"CollectorFilter\\: (...args) => boolean \\| Promise\\",source:"@site/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",sourceDirName:"reference/structures/Collector/type-aliases",slug:"/reference/structures/Collector/type-aliases/CollectorFilter",permalink:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: CollectorOptions",permalink:"/docs/reference/structures/Collector/interfaces/CollectorOptions"},next:{title:"structures/Dialog",permalink:"/docs/reference/structures/Dialog/"}},i={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function d(e){const r={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"type-alias-collectorfiltert",children:"Type Alias: CollectorFilter()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"CollectorFilter"}),"<",(0,s.jsx)(r.code,{children:"T"}),">: (...",(0,s.jsx)(r.code,{children:"args"}),") => ",(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," ",(0,s.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ...",(0,s.jsx)(r.strong,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"T"})]}),"\n",(0,s.jsx)(r.p,{children:"Any arguments received by the listener"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>n});var s=t(6540);const o={},l=s.createContext(o);function c(e){const r=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function n(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(l.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eaeca54c.058f32f5.js b/assets/js/eaeca54c.058f32f5.js deleted file mode 100644 index a4305e7342..0000000000 --- a/assets/js/eaeca54c.058f32f5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9940],{7753:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var n=r(4848),t=r(8453);const c={},o="structures/preProcessors",i={id:"reference/structures/preProcessors/index",title:"structures/preProcessors",description:"Index",source:"@site/docs/reference/structures/preProcessors/index.md",sourceDirName:"reference/structures/preProcessors",slug:"/reference/structures/preProcessors/",permalink:"/docs/reference/structures/preProcessors/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector"},next:{title:"Enumeration: PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS"}},a={},u=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3}];function l(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"structurespreprocessors",children:"structures/preProcessors"}),"\n",(0,n.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:"PREPROCESSORS"})}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",children:"MPConfigType"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:"MessagePreProcessor"})}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"variables",children:"Variables"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",children:"MessagePreprocessors"})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>o,x:()=>i});var n=r(6540);const t={},c=n.createContext(t);function o(e){const s=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eaeca54c.bd7f869d.js b/assets/js/eaeca54c.bd7f869d.js new file mode 100644 index 0000000000..c558653433 --- /dev/null +++ b/assets/js/eaeca54c.bd7f869d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9940],{7753:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var n=r(4848),t=r(8453);const c={},o="structures/preProcessors",i={id:"reference/structures/preProcessors/index",title:"structures/preProcessors",description:"Index",source:"@site/docs/reference/structures/preProcessors/index.md",sourceDirName:"reference/structures/preProcessors",slug:"/reference/structures/preProcessors/",permalink:"/docs/reference/structures/preProcessors/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/preProcessors/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: MessageCollector",permalink:"/docs/reference/structures/MessageCollector/classes/MessageCollector"},next:{title:"Enumeration: PREPROCESSORS",permalink:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS"}},a={},u=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3}];function l(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"structurespreprocessors",children:"structures/preProcessors"})}),"\n",(0,n.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",children:"PREPROCESSORS"})}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",children:"MPConfigType"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",children:"MessagePreProcessor"})}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"variables",children:"Variables"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",children:"MessagePreprocessors"})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,s,r)=>{r.d(s,{R:()=>o,x:()=>i});var n=r(6540);const t={},c=n.createContext(t);function o(e){const s=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),n.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed88e295.0e210d69.js b/assets/js/ed88e295.0e210d69.js deleted file mode 100644 index ab441be90c..0000000000 --- a/assets/js/ed88e295.0e210d69.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3371],{744:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>g,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var t=o(4848),r=o(8453);const s={},i="Type Alias: ConfigLogTransport",l={id:"reference/logging/logging/type-aliases/ConfigLogTransport",title:"Type Alias: ConfigLogTransport",description:"ConfigLogTransport: object",source:"@site/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",sourceDirName:"reference/logging/logging/type-aliases",slug:"/reference/logging/logging/type-aliases/ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: addRotateFileLogTransport()",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport"},next:{title:"Variable: log",permalink:"/docs/reference/logging/logging/variables/log"}},c={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"done?",id:"done",level:3},{value:"options?",id:"options",level:3},{value:"type",id:"type",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-configlogtransport",children:"Type Alias: ConfigLogTransport"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ConfigLogTransport"}),": ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,t.jsx)(n.h3,{id:"done",children:"done?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"done"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"If the transport has already been added to the logger. The logging set up command handles this for you."}),"\n",(0,t.jsx)(n.h3,{id:"options",children:"options?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports."}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"syslog"'})," | ",(0,t.jsx)(n.code,{children:'"console"'})," | ",(0,t.jsx)(n.code,{children:'"file"'})," | ",(0,t.jsx)(n.code,{children:'"ev"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The type of winston transport. At the moment only ",(0,t.jsx)(n.code,{children:"file"}),", ",(0,t.jsx)(n.code,{children:"console"}),", ",(0,t.jsx)(n.code,{children:"ev"})," and ",(0,t.jsx)(n.code,{children:"syslog"})," are supported."]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>l});var t=o(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed88e295.f90d3f45.js b/assets/js/ed88e295.f90d3f45.js new file mode 100644 index 0000000000..1894d81b47 --- /dev/null +++ b/assets/js/ed88e295.f90d3f45.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3371],{744:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>g,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var r=o(4848),t=o(8453);const s={},i="Type Alias: ConfigLogTransport",l={id:"reference/logging/logging/type-aliases/ConfigLogTransport",title:"Type Alias: ConfigLogTransport",description:"ConfigLogTransport: object",source:"@site/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",sourceDirName:"reference/logging/logging/type-aliases",slug:"/reference/logging/logging/type-aliases/ConfigLogTransport",permalink:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Function: addRotateFileLogTransport()",permalink:"/docs/reference/logging/logging/functions/addRotateFileLogTransport"},next:{title:"Variable: log",permalink:"/docs/reference/logging/logging/variables/log"}},c={},d=[{value:"Type declaration",id:"type-declaration",level:2},{value:"done?",id:"done",level:3},{value:"options?",id:"options",level:3},{value:"type",id:"type",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"type-alias-configlogtransport",children:"Type Alias: ConfigLogTransport"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ConfigLogTransport"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"done",children:"done?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"done"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the transport has already been added to the logger. The logging set up command handles this for you."}),"\n",(0,r.jsx)(n.h3,{id:"options",children:"options?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports."}),"\n",(0,r.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"type"}),": ",(0,r.jsx)(n.code,{children:'"syslog"'})," | ",(0,r.jsx)(n.code,{children:'"console"'})," | ",(0,r.jsx)(n.code,{children:'"file"'})," | ",(0,r.jsx)(n.code,{children:'"ev"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The type of winston transport. At the moment only ",(0,r.jsx)(n.code,{children:"file"}),", ",(0,r.jsx)(n.code,{children:"console"}),", ",(0,r.jsx)(n.code,{children:"ev"})," and ",(0,r.jsx)(n.code,{children:"syslog"})," are supported."]})]})}function g(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>l});var r=o(6540);const t={},s=r.createContext(t);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edb57414.d9dbd118.js b/assets/js/edb57414.d9dbd118.js deleted file mode 100644 index cb600c3c96..0000000000 --- a/assets/js/edb57414.d9dbd118.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1425],{1777:(t,a,e)=>{e.r(a),e.d(a,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var n=e(4848),i=e(8453);const c={},r="Manage Participants",o={id:"how-to/manage-participants",title:"Manage Participants",description:"[[addParticipant]] - add a participant",source:"@site/docs/how-to/manage-participants.md",sourceDirName:"how-to",slug:"/how-to/manage-participants",permalink:"/docs/how-to/manage-participants",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/manage-participants.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Location",permalink:"/docs/how-to/location"},next:{title:"More examples",permalink:"/docs/how-to/misc"}},s={},p=[];function d(t){const a={code:"code",h1:"h1",p:"p",pre:"pre",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.h1,{id:"manage-participants",children:"Manage Participants"}),"\n",(0,n.jsx)(a.p,{children:"[[addParticipant]] - add a participant\n[[removeParticipant]] - remove a particpant\n[[promoteParticipant]] - Make a participant admin\n[[demoteParticipant]] - remove participant as admin"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-javascript",children:"...\n client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n...\n"})})]})}function u(t={}){const{wrapper:a}={...(0,i.R)(),...t.components};return a?(0,n.jsx)(a,{...t,children:(0,n.jsx)(d,{...t})}):d(t)}},8453:(t,a,e)=>{e.d(a,{R:()=>r,x:()=>o});var n=e(6540);const i={},c=n.createContext(i);function r(t){const a=n.useContext(c);return n.useMemo((function(){return"function"==typeof t?t(a):{...a,...t}}),[a,t])}function o(t){let a;return a=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:r(t.components),n.createElement(c.Provider,{value:a},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/edb57414.e7aa6c9f.js b/assets/js/edb57414.e7aa6c9f.js new file mode 100644 index 0000000000..3462952c79 --- /dev/null +++ b/assets/js/edb57414.e7aa6c9f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1425],{1777:(t,a,e)=>{e.r(a),e.d(a,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var n=e(4848),i=e(8453);const c={},r="Manage Participants",o={id:"how-to/manage-participants",title:"Manage Participants",description:"[[addParticipant]] - add a participant",source:"@site/docs/how-to/manage-participants.md",sourceDirName:"how-to",slug:"/how-to/manage-participants",permalink:"/docs/how-to/manage-participants",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/manage-participants.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Location",permalink:"/docs/how-to/location"},next:{title:"More examples",permalink:"/docs/how-to/misc"}},s={},p=[];function d(t){const a={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.header,{children:(0,n.jsx)(a.h1,{id:"manage-participants",children:"Manage Participants"})}),"\n",(0,n.jsx)(a.p,{children:"[[addParticipant]] - add a participant\n[[removeParticipant]] - remove a particpant\n[[promoteParticipant]] - Make a participant admin\n[[demoteParticipant]] - remove participant as admin"}),"\n",(0,n.jsx)(a.pre,{children:(0,n.jsx)(a.code,{className:"language-javascript",children:"...\n client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')\n...\n"})})]})}function u(t={}){const{wrapper:a}={...(0,i.R)(),...t.components};return a?(0,n.jsx)(a,{...t,children:(0,n.jsx)(d,{...t})}):d(t)}},8453:(t,a,e)=>{e.d(a,{R:()=>r,x:()=>o});var n=e(6540);const i={},c=n.createContext(i);function r(t){const a=n.useContext(c);return n.useMemo((function(){return"function"==typeof t?t(a):{...a,...t}}),[a,t])}function o(t){let a;return a=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:r(t.components),n.createElement(c.Provider,{value:a},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/edc18652.8a8e1489.js b/assets/js/edc18652.8a8e1489.js deleted file mode 100644 index c1e1a9262b..0000000000 --- a/assets/js/edc18652.8a8e1489.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5107],{5257:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=r(4848),s=r(8453);const o={},i="Enumeration: ValidationType",c={id:"reference/structures/Dialog/enumerations/ValidationType",title:"Enumeration: ValidationType",description:"Enumeration Members",source:"@site/docs/reference/structures/Dialog/enumerations/ValidationType.md",sourceDirName:"reference/structures/Dialog/enumerations",slug:"/reference/structures/Dialog/enumerations/ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/enumerations/ValidationType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/Dialog",permalink:"/docs/reference/structures/Dialog/"},next:{title:"Interface: CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps"}},a={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CHECK",id:"check",level:3},{value:"LENGTH",id:"length",level:3},{value:"REGEX",id:"regex",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-validationtype",children:"Enumeration: ValidationType"}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"check",children:"CHECK"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHECK"}),": ",(0,t.jsx)(n.code,{children:'"check"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"length",children:"LENGTH"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"LENGTH"}),": ",(0,t.jsx)(n.code,{children:'"length"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"regex",children:"REGEX"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"REGEX"}),": ",(0,t.jsx)(n.code,{children:'"regex"'})]}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var t=r(6540);const s={},o=t.createContext(s);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edc18652.de95958c.js b/assets/js/edc18652.de95958c.js new file mode 100644 index 0000000000..41b0c6c08f --- /dev/null +++ b/assets/js/edc18652.de95958c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5107],{5257:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=r(4848),s=r(8453);const o={},i="Enumeration: ValidationType",c={id:"reference/structures/Dialog/enumerations/ValidationType",title:"Enumeration: ValidationType",description:"Enumeration Members",source:"@site/docs/reference/structures/Dialog/enumerations/ValidationType.md",sourceDirName:"reference/structures/Dialog/enumerations",slug:"/reference/structures/Dialog/enumerations/ValidationType",permalink:"/docs/reference/structures/Dialog/enumerations/ValidationType",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Dialog/enumerations/ValidationType.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/Dialog",permalink:"/docs/reference/structures/Dialog/"},next:{title:"Interface: CurrentDialogProps",permalink:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps"}},a={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"CHECK",id:"check",level:3},{value:"LENGTH",id:"length",level:3},{value:"REGEX",id:"regex",level:3}];function u(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"enumeration-validationtype",children:"Enumeration: ValidationType"})}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"check",children:"CHECK"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"CHECK"}),": ",(0,t.jsx)(n.code,{children:'"check"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"length",children:"LENGTH"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"LENGTH"}),": ",(0,t.jsx)(n.code,{children:'"length"'})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"regex",children:"REGEX"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"REGEX"}),": ",(0,t.jsx)(n.code,{children:'"regex"'})]}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var t=r(6540);const s={},o=t.createContext(s);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ee112ecc.21cc3734.js b/assets/js/ee112ecc.21cc3734.js deleted file mode 100644 index 2830acce7d..0000000000 --- a/assets/js/ee112ecc.21cc3734.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{565:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(4848),s=n(8453);const i={},a="Interface: GroupChatCreationResponse",o={id:"reference/api/model/chat/interfaces/GroupChatCreationResponse",title:"Interface: GroupChatCreationResponse",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse"},next:{title:"Interface: LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"gid",id:"gid",level:3},{value:"participants",id:"participants",level:3},{value:"status",id:"status",level:3}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-groupchatcreationresponse",children:"Interface: GroupChatCreationResponse"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"gid",children:"gid"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"gid"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(t.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The group chat id"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"participants",children:"participants"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"participants"}),": ",(0,r.jsx)(t.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The initial requested participants and their corresponding add responses"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"status"}),": ",(0,r.jsx)(t.code,{children:"200"})," | ",(0,r.jsx)(t.code,{children:"400"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The resultant status code of the group chat creation."}),"\n",(0,r.jsx)(t.p,{children:"200 if the group was created successfully."}),"\n",(0,r.jsx)(t.p,{children:"400 if the initial participant does not exist"})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>o});var r=n(6540);const s={},i=r.createContext(s);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ee112ecc.7c0096a2.js b/assets/js/ee112ecc.7c0096a2.js new file mode 100644 index 0000000000..30479a09d5 --- /dev/null +++ b/assets/js/ee112ecc.7c0096a2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{565:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(4848),s=n(8453);const i={},a="Interface: GroupChatCreationResponse",o={id:"reference/api/model/chat/interfaces/GroupChatCreationResponse",title:"Interface: GroupChatCreationResponse",description:"Properties",source:"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",sourceDirName:"reference/api/model/chat/interfaces",slug:"/reference/api/model/chat/interfaces/GroupChatCreationResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: GroupChatCreationParticipantAddResponse",permalink:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse"},next:{title:"Interface: LiveLocationChangedEvent",permalink:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"gid",id:"gid",level:3},{value:"participants",id:"participants",level:3},{value:"status",id:"status",level:3}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-groupchatcreationresponse",children:"Interface: GroupChatCreationResponse"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"gid",children:"gid"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"gid"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(t.code,{children:"GroupChatId"})})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The group chat id"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"participants",children:"participants"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"participants"}),": ",(0,r.jsx)(t.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The initial requested participants and their corresponding add responses"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"status"}),": ",(0,r.jsx)(t.code,{children:"200"})," | ",(0,r.jsx)(t.code,{children:"400"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The resultant status code of the group chat creation."}),"\n",(0,r.jsx)(t.p,{children:"200 if the group was created successfully."}),"\n",(0,r.jsx)(t.p,{children:"400 if the initial participant does not exist"})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>o});var r=n(6540);const s={},i=r.createContext(s);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef89b32c.2c73008f.js b/assets/js/ef89b32c.2c73008f.js deleted file mode 100644 index 8de8f7716a..0000000000 --- a/assets/js/ef89b32c.2c73008f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4171],{7056:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var o=t(4848),i=t(8453);const s={title:"Logging in with a link code",sidebar_label:"Link Code Login",sidebar_position:3,description:"Simple docs showing how to use open-wa/wa-automate with a link code."},c="Intro",a={id:"get-started/link-code",title:"Logging in with a link code",description:"Simple docs showing how to use open-wa/wa-automate with a link code.",source:"@site/docs/get-started/link-code.md",sourceDirName:"get-started",slug:"/get-started/link-code",permalink:"/docs/get-started/link-code",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/link-code.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Logging in with a link code",sidebar_label:"Link Code Login",sidebar_position:3,description:"Simple docs showing how to use open-wa/wa-automate with a link code."},sidebar:"tutorialSidebar",previous:{title:"Custom Code",permalink:"/docs/get-started/installation"},next:{title:"Socket mode",permalink:"/docs/get-started/socketmode"}},r={},d=[{value:"Easy API",id:"easy-api",level:2},{value:"In code",id:"in-code",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"intro",children:"Intro"}),"\n",(0,o.jsx)(n.p,{children:"For many years the standard way to login to your host account was to scan a QR code. However, recently link code has been introduced as an option. This guide will show you how to use the link code to login to your host account."}),"\n",(0,o.jsx)(n.p,{children:"The main thing to know is that you will need to know exactly which host account number you're using before starting the session. This is because the link code is specific to the host account number."}),"\n",(0,o.jsx)(n.p,{children:"Once the link code is requested from the session, the host account device will be sent a notification to confirm the login. Once confirmed, the host account device will ask you to enter the link code."}),"\n",(0,o.jsxs)(n.p,{children:["The link code is a 8 character string that is displayed on the screen of the host account device with a ",(0,o.jsx)(n.code,{children:"-"})," in between, for example: ",(0,o.jsx)(n.code,{children:"1EV4-5A78"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["In open-wa, the way to activate the link code request is to set the host account number as a string or number beforehand as a property of the config object in the ",(0,o.jsx)(n.code,{children:"linkCode"})," property."]}),"\n",(0,o.jsx)(n.h2,{id:"easy-api",children:"Easy API"}),"\n",(0,o.jsx)(n.p,{children:"If you're using the Easy API, you can set the link code in the config object like so:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"> npx @open-wa/wa-automate --link-code '447123456789'\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Or if you're using the ",(0,o.jsx)(n.code,{children:"cli.config.json"})," file:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-json",children:'{\n "linkCode": "447123456789"\n}\n'})}),"\n",(0,o.jsx)(n.h2,{id:"in-code",children:"In code"}),"\n",(0,o.jsx)(n.p,{children:"You can also set the link code manually in the code like so:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n linkCode: '447123456789'\n})\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef89b32c.da99c7e9.js b/assets/js/ef89b32c.da99c7e9.js new file mode 100644 index 0000000000..04d9287583 --- /dev/null +++ b/assets/js/ef89b32c.da99c7e9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4171],{7056:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var o=t(4848),i=t(8453);const s={title:"Logging in with a link code",sidebar_label:"Link Code Login",sidebar_position:3,description:"Simple docs showing how to use open-wa/wa-automate with a link code."},c="Intro",a={id:"get-started/link-code",title:"Logging in with a link code",description:"Simple docs showing how to use open-wa/wa-automate with a link code.",source:"@site/docs/get-started/link-code.md",sourceDirName:"get-started",slug:"/get-started/link-code",permalink:"/docs/get-started/link-code",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/get-started/link-code.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Logging in with a link code",sidebar_label:"Link Code Login",sidebar_position:3,description:"Simple docs showing how to use open-wa/wa-automate with a link code."},sidebar:"tutorialSidebar",previous:{title:"Custom Code",permalink:"/docs/get-started/installation"},next:{title:"Socket mode",permalink:"/docs/get-started/socketmode"}},r={},d=[{value:"Easy API",id:"easy-api",level:2},{value:"In code",id:"in-code",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"intro",children:"Intro"})}),"\n",(0,o.jsx)(n.p,{children:"For many years the standard way to login to your host account was to scan a QR code. However, recently link code has been introduced as an option. This guide will show you how to use the link code to login to your host account."}),"\n",(0,o.jsx)(n.p,{children:"The main thing to know is that you will need to know exactly which host account number you're using before starting the session. This is because the link code is specific to the host account number."}),"\n",(0,o.jsx)(n.p,{children:"Once the link code is requested from the session, the host account device will be sent a notification to confirm the login. Once confirmed, the host account device will ask you to enter the link code."}),"\n",(0,o.jsxs)(n.p,{children:["The link code is a 8 character string that is displayed on the screen of the host account device with a ",(0,o.jsx)(n.code,{children:"-"})," in between, for example: ",(0,o.jsx)(n.code,{children:"1EV4-5A78"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["In open-wa, the way to activate the link code request is to set the host account number as a string or number beforehand as a property of the config object in the ",(0,o.jsx)(n.code,{children:"linkCode"})," property."]}),"\n",(0,o.jsx)(n.h2,{id:"easy-api",children:"Easy API"}),"\n",(0,o.jsx)(n.p,{children:"If you're using the Easy API, you can set the link code in the config object like so:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"> npx @open-wa/wa-automate --link-code '447123456789'\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Or if you're using the ",(0,o.jsx)(n.code,{children:"cli.config.json"})," file:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-json",children:'{\n "linkCode": "447123456789"\n}\n'})}),"\n",(0,o.jsx)(n.h2,{id:"in-code",children:"In code"}),"\n",(0,o.jsx)(n.p,{children:"You can also set the link code manually in the code like so:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-javascript",children:"create({\n linkCode: '447123456789'\n})\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef8b811a.59f84152.js b/assets/js/ef8b811a.59f84152.js new file mode 100644 index 0000000000..2cd08c1b42 --- /dev/null +++ b/assets/js/ef8b811a.59f84152.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8947],{6600:e=>{e.exports=JSON.parse('{"authors":[{"name":"Endilie Yacop Sucipto","title":"Maintainer of Docusaurus","url":"https://github.com/endiliey","imageURL":"https://github.com/endiliey.png","key":"endi","page":null,"count":1},{"name":"Yangshun Tay","title":"Front End Engineer @ Facebook","url":"https://github.com/yangshun","imageURL":"https://github.com/yangshun.png","key":"yangshun","page":null,"count":1},{"name":"S\xe9bastien Lorber","title":"Docusaurus maintainer","url":"https://sebastienlorber.com","imageURL":"https://github.com/slorber.png","key":"slorber","page":null,"count":2}]}')}}]); \ No newline at end of file diff --git a/assets/js/eff1717c.40792e82.js b/assets/js/eff1717c.40792e82.js deleted file mode 100644 index e2c2b49c34..0000000000 --- a/assets/js/eff1717c.40792e82.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1399],{4997:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var n=a(4848),r=a(8453);const s={},c="Type Alias: Chat",o={id:"reference/api/model/chat/type-aliases/Chat",title:"Type Alias: Chat",description:"Chat: SingleChat \\| GroupChat",source:"@site/docs/reference/api/model/chat/type-aliases/Chat.md",sourceDirName:"reference/api/model/chat/type-aliases",slug:"/reference/api/model/chat/type-aliases/Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/type-aliases/Chat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat"},next:{title:"Type Alias: EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration"}},i={},l=[];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-chat",children:"Type Alias: Chat"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Chat"}),": ",(0,n.jsx)(t.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:(0,n.jsx)(t.code,{children:"SingleChat"})})," | ",(0,n.jsx)(t.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:(0,n.jsx)(t.code,{children:"GroupChat"})})]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>c,x:()=>o});var n=a(6540);const r={},s=n.createContext(r);function c(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eff1717c.77b72d3d.js b/assets/js/eff1717c.77b72d3d.js new file mode 100644 index 0000000000..e517983462 --- /dev/null +++ b/assets/js/eff1717c.77b72d3d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1399],{4997:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=a(4848),n=a(8453);const s={},c="Type Alias: Chat",o={id:"reference/api/model/chat/type-aliases/Chat",title:"Type Alias: Chat",description:"Chat: SingleChat \\| GroupChat",source:"@site/docs/reference/api/model/chat/type-aliases/Chat.md",sourceDirName:"reference/api/model/chat/type-aliases",slug:"/reference/api/model/chat/type-aliases/Chat",permalink:"/docs/reference/api/model/chat/type-aliases/Chat",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/type-aliases/Chat.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SingleChat",permalink:"/docs/reference/api/model/chat/interfaces/SingleChat"},next:{title:"Type Alias: EphemeralDuration",permalink:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration"}},i={},l=[];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"type-alias-chat",children:"Type Alias: Chat"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Chat"}),": ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:(0,r.jsx)(t.code,{children:"SingleChat"})})," | ",(0,r.jsx)(t.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:(0,r.jsx)(t.code,{children:"GroupChat"})})]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>c,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function c(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f0def62b.16f049ad.js b/assets/js/f0def62b.16f049ad.js new file mode 100644 index 0000000000..e3dac888ec --- /dev/null +++ b/assets/js/f0def62b.16f049ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9584],{720:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(4848),r=s(8453);const o={},c="Interface: HealthCheck",t={id:"reference/api/model/sessionInfo/interfaces/HealthCheck",title:"Interface: HealthCheck",description:"Properties",source:"@site/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",sourceDirName:"reference/api/model/sessionInfo/interfaces",slug:"/reference/api/model/sessionInfo/interfaces/HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/sessionInfo",permalink:"/docs/reference/api/model/sessionInfo/"},next:{title:"Interface: SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"batteryLow?",id:"batterylow",level:3},{value:"isHere?",id:"ishere",level:3},{value:"isPhoneDisconnected?",id:"isphonedisconnected",level:3},{value:"online?",id:"online",level:3},{value:"queuedMessages?",id:"queuedmessages",level:3},{value:"retryingIn?",id:"retryingin",level:3},{value:"state?",id:"state",level:3},{value:"tryingToReachPhone?",id:"tryingtoreachphone",level:3},{value:"wapiInjected?",id:"wapiinjected",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-healthcheck",children:"Interface: HealthCheck"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"batterylow",children:"batteryLow?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"batteryLow"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "Phone battery low" message is detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ishere",children:"isHere?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isHere"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "Use Here" button is not detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isPhoneDisconnected"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Whether or not the "Phone is disconnected" message is showing within the web app.'}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"online",children:"online?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"online"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Result of ",(0,i.jsx)(n.code,{children:"window.navigator.onLine"})]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"queuedmessages",children:"queuedMessages?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"queuedMessages"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of messages queued up in the browser. Messages can start being queued up due to the web app awaiting a connection with the host device."}),"\n",(0,i.jsx)(n.p,{children:"Healthy: 0"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"retryingin",children:"retryingIn?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"retryingIn"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:['Returns the number of seconds the "Retrying in ..." dialog is indicating. If the dialog is not showing, it will return ',(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"state?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"state"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,i.jsx)(n.code,{children:"STATE"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The state of the web app."}),"\n",(0,i.jsx)(n.p,{children:"Healthy: 'CONNECTED'"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tryingtoreachphone",children:"tryingToReachPhone?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tryingToReachPhone"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "trying to reach phone" dialog is detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"wapiinjected",children:"wapiInjected?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"wapiInjected"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the ",(0,i.jsx)(n.code,{children:"WAPI"})," object is detected."]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>t});var i=s(6540);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f0def62b.7d24c0a5.js b/assets/js/f0def62b.7d24c0a5.js deleted file mode 100644 index 4a4b32ab42..0000000000 --- a/assets/js/f0def62b.7d24c0a5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9584],{720:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(4848),r=s(8453);const o={},c="Interface: HealthCheck",t={id:"reference/api/model/sessionInfo/interfaces/HealthCheck",title:"Interface: HealthCheck",description:"Properties",source:"@site/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",sourceDirName:"reference/api/model/sessionInfo/interfaces",slug:"/reference/api/model/sessionInfo/interfaces/HealthCheck",permalink:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/sessionInfo",permalink:"/docs/reference/api/model/sessionInfo/"},next:{title:"Interface: SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"batteryLow?",id:"batterylow",level:3},{value:"isHere?",id:"ishere",level:3},{value:"isPhoneDisconnected?",id:"isphonedisconnected",level:3},{value:"online?",id:"online",level:3},{value:"queuedMessages?",id:"queuedmessages",level:3},{value:"retryingIn?",id:"retryingin",level:3},{value:"state?",id:"state",level:3},{value:"tryingToReachPhone?",id:"tryingtoreachphone",level:3},{value:"wapiInjected?",id:"wapiinjected",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-healthcheck",children:"Interface: HealthCheck"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"batterylow",children:"batteryLow?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"batteryLow"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "Phone battery low" message is detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ishere",children:"isHere?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isHere"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "Use Here" button is not detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isPhoneDisconnected"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Whether or not the "Phone is disconnected" message is showing within the web app.'}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"online",children:"online?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"online"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Result of ",(0,i.jsx)(n.code,{children:"window.navigator.onLine"})]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"queuedmessages",children:"queuedMessages?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"queuedMessages"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The number of messages queued up in the browser. Messages can start being queued up due to the web app awaiting a connection with the host device."}),"\n",(0,i.jsx)(n.p,{children:"Healthy: 0"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"retryingin",children:"retryingIn?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"retryingIn"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:['Returns the number of seconds the "Retrying in ..." dialog is indicating. If the dialog is not showing, it will return ',(0,i.jsx)(n.code,{children:"0"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"state?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"state"}),": ",(0,i.jsx)(n.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,i.jsx)(n.code,{children:"STATE"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The state of the web app."}),"\n",(0,i.jsx)(n.p,{children:"Healthy: 'CONNECTED'"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tryingtoreachphone",children:"tryingToReachPhone?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tryingToReachPhone"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"}),' if "trying to reach phone" dialog is detected']}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"wapiinjected",children:"wapiInjected?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"wapiInjected"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the ",(0,i.jsx)(n.code,{children:"WAPI"})," object is detected."]}),"\n",(0,i.jsxs)(n.p,{children:["Healthy: ",(0,i.jsx)(n.code,{children:"true"})]})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>t});var i=s(6540);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f1169565.5ff03461.js b/assets/js/f1169565.5ff03461.js deleted file mode 100644 index 51880312ae..0000000000 --- a/assets/js/f1169565.5ff03461.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2884],{3411:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var n=s(4848),i=s(8453);const c={},t="Class: PageEvaluationTimeout",d={id:"reference/api/model/errors/classes/PageEvaluationTimeout",title:"Class: PageEvaluationTimeout",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError"},next:{title:"Class: SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError"}},l={},a=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new PageEvaluationTimeout()",id:"new-pageevaluationtimeout",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function o(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"class-pageevaluationtimeout",children:"Class: PageEvaluationTimeout"}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-pageevaluationtimeout",children:"new PageEvaluationTimeout()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new PageEvaluationTimeout"}),"(...",(0,n.jsx)(r.code,{children:"args"}),"): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:(0,n.jsx)(r.code,{children:"PageEvaluationTimeout"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ...",(0,n.jsx)(r.strong,{children:"args"}),": ",(0,n.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:(0,n.jsx)(r.code,{children:"PageEvaluationTimeout"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>t,x:()=>d});var n=s(6540);const i={},c=n.createContext(i);function t(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f1169565.fca6f86d.js b/assets/js/f1169565.fca6f86d.js new file mode 100644 index 0000000000..e4e5281d8b --- /dev/null +++ b/assets/js/f1169565.fca6f86d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2884],{3411:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var n=s(4848),i=s(8453);const c={},t="Class: PageEvaluationTimeout",d={id:"reference/api/model/errors/classes/PageEvaluationTimeout",title:"Class: PageEvaluationTimeout",description:"Extends",source:"@site/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError"},next:{title:"Class: SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError"}},l={},a=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new PageEvaluationTimeout()",id:"new-pageevaluationtimeout",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function o(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"class-pageevaluationtimeout",children:"Class: PageEvaluationTimeout"})}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-pageevaluationtimeout",children:"new PageEvaluationTimeout()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new PageEvaluationTimeout"}),"(...",(0,n.jsx)(r.code,{children:"args"}),"): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:(0,n.jsx)(r.code,{children:"PageEvaluationTimeout"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ...",(0,n.jsx)(r.strong,{children:"args"}),": ",(0,n.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:(0,n.jsx)(r.code,{children:"PageEvaluationTimeout"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>t,x:()=>d});var n=s(6540);const i={},c=n.createContext(i);function t(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f2171f78.f1862a96.js b/assets/js/f2171f78.f1862a96.js deleted file mode 100644 index d7b4847e5c..0000000000 --- a/assets/js/f2171f78.f1862a96.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6283],{1576:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>t});var r=s(4848),i=s(8453);const a={},d="Interface: MessageInfo",c={id:"reference/api/model/message/interfaces/MessageInfo",title:"Interface: MessageInfo",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/MessageInfo.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/MessageInfo.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Message",permalink:"/docs/reference/api/model/message/interfaces/Message"},next:{title:"Interface: MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"delivery",id:"delivery",level:3},{value:"deliveryRemaining",id:"deliveryremaining",level:3},{value:"id",id:"id",level:3},{value:"played",id:"played",level:3},{value:"playedRemaining",id:"playedremaining",level:3},{value:"read",id:"read",level:3},{value:"readRemaining",id:"readremaining",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-messageinfo",children:"Interface: MessageInfo"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"delivery",children:"delivery"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"delivery"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deliveryremaining",children:"deliveryRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"deliveryRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"played",children:"played"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"played"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"playedremaining",children:"playedRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"playedRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"readremaining",children:"readRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"readRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var r=s(6540);const i={},a=r.createContext(i);function d(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f2171f78.f9ee9fb5.js b/assets/js/f2171f78.f9ee9fb5.js new file mode 100644 index 0000000000..bf2731aea0 --- /dev/null +++ b/assets/js/f2171f78.f9ee9fb5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6283],{1576:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>t});var r=s(4848),i=s(8453);const a={},d="Interface: MessageInfo",c={id:"reference/api/model/message/interfaces/MessageInfo",title:"Interface: MessageInfo",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/MessageInfo.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/MessageInfo",permalink:"/docs/reference/api/model/message/interfaces/MessageInfo",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/MessageInfo.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: Message",permalink:"/docs/reference/api/model/message/interfaces/Message"},next:{title:"Interface: MessageInfoInteraction",permalink:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"delivery",id:"delivery",level:3},{value:"deliveryRemaining",id:"deliveryremaining",level:3},{value:"id",id:"id",level:3},{value:"played",id:"played",level:3},{value:"playedRemaining",id:"playedremaining",level:3},{value:"read",id:"read",level:3},{value:"readRemaining",id:"readremaining",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-messageinfo",children:"Interface: MessageInfo"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"delivery",children:"delivery"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"delivery"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deliveryremaining",children:"deliveryRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"deliveryRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"played",children:"played"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"played"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"playedremaining",children:"playedRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"playedRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:(0,r.jsx)(n.code,{children:"MessageInfoInteraction"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"readremaining",children:"readRemaining"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"readRemaining"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var r=s(6540);const i={},a=r.createContext(i);function d(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f22ab3cc.3b2c5a7c.js b/assets/js/f22ab3cc.3b2c5a7c.js deleted file mode 100644 index 9a964163dc..0000000000 --- a/assets/js/f22ab3cc.3b2c5a7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[583],{8590:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=r(4848),i=r(8453);const t={},l="Class: Collector",c={id:"reference/structures/Collector/classes/Collector",title:"Class: Collector",description:"Abstract class for defining a new Collector.",source:"@site/docs/reference/structures/Collector/classes/Collector.md",sourceDirName:"reference/structures/Collector/classes",slug:"/reference/structures/Collector/classes/Collector",permalink:"/docs/reference/structures/Collector/classes/Collector",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/classes/Collector.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Collection\\",permalink:"/docs/reference/structures/Collector/classes/Collection"},next:{title:"Interface: AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions"}},d={},o=[{value:"Abstract",id:"abstract",level:2},{value:"Extends",id:"extends",level:2},{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Collector()",id:"new-collector",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_idletimeout",id:"_idletimeout",level:3},{value:"_timeout",id:"_timeout",level:3},{value:"collected",id:"collected",level:3},{value:"ended",id:"ended",level:3},{value:"filter()",id:"filter",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"options",id:"options",level:3},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Accessors",id:"accessors",level:2},{value:"next",id:"next",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Methods",id:"methods",level:2},{value:"[asyncIterator]()",id:"asynciterator",level:3},{value:"Returns",id:"returns-3",level:4},{value:"See",id:"see",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"checkEnd()",id:"checkend",level:3},{value:"Returns",id:"returns-5",level:4},{value:"clearImmediate()",id:"clearimmediate",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"clearInterval()",id:"clearinterval",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"clearTimeout()",id:"cleartimeout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"collect()",id:"collect",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-9",level:4},{value:"See",id:"see-1",level:4},{value:"Abstract",id:"abstract-1",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Returns",id:"returns-10",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-11",level:4},{value:"See",id:"see-2",level:4},{value:"Abstract",id:"abstract-2",level:4},{value:"emit()",id:"emit",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"endReason()",id:"endreason",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Abstract",id:"abstract-3",level:4},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"handleCollect()",id:"handlecollect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Emits",id:"emits",level:4},{value:"handleDispose()",id:"handledispose",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Emits",id:"emits-1",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"on()",id:"on",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"once()",id:"once",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Since",id:"since-11",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-12",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-13",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"resetTimer()",id:"resettimer",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-28",level:4},{value:"setImmediate()",id:"setimmediate",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-29",level:4},{value:"setInterval()",id:"setinterval",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-30",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Since",id:"since-14",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"setTimeout()",id:"settimeout",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-32",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Emits",id:"emits-2",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Since",id:"since-15",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Since",id:"since-16",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-18",level:5},{value:"Inherited from",id:"inherited-from-22",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Inherited from",id:"inherited-from-23",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Since",id:"since-19",level:4},{value:"Inherited from",id:"inherited-from-24",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"class-collector",children:"Class: Collector"}),"\n",(0,s.jsx)(n.p,{children:"Abstract class for defining a new Collector."}),"\n",(0,s.jsx)(n.h2,{id:"abstract",children:"Abstract"}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"EventEmitter"})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-collector",children:"new Collector()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collector"}),"(",(0,s.jsx)(n.code,{children:"filter"}),", ",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,s.jsx)(n.code,{children:"CollectorFilter"})}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})," = ",(0,s.jsx)(n.code,{children:"{}"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.constructor"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"_idletimeout",children:"_idletimeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_idletimeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_timeout",children:"_timeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collected",children:"collected"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collected"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ended",children:"ended"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),": (...",(0,s.jsx)(n.code,{children:"args"}),") => ",(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.captureRejectionSymbol"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.captureRejections"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.defaultMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,s.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,s.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,s.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,s.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,s.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.errorMonitor"})}),"\n",(0,s.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,s.jsx)(n.h3,{id:"next",children:"next"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"get"})," ",(0,s.jsx)(n.strong,{children:"next"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a promise that resolves with the next collected element;\nrejects with collected elements if the collector finishes without receiving a next element"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"asynciterator",children:"[asyncIterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[asyncIterator]"}),"(): ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Allows collectors to be consumed with for-await-of loops"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of",children:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"addListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.addListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"checkend",children:"checkEnd()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"checkEnd"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks whether the collector should end, and if so, ends it."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearimmediate",children:"clearImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearImmediate"}),"(",(0,s.jsx)(n.code,{children:"immediate"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an immediate."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"immediate"}),": ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n",(0,s.jsx)(n.p,{children:"Immediate to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearinterval",children:"clearInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearInterval"}),"(",(0,s.jsx)(n.code,{children:"interval"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an interval."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"interval"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Interval to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cleartimeout",children:"clearTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearTimeout"}),"(",(0,s.jsx)(n.code,{children:"timeout"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears a timeout."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collect",children:"collect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Handles incoming events from the ",(0,s.jsx)(n.code,{children:"handleCollect"})," function. Returns null if the event should not\nbe collected, or returns an object describing the data that should be stored."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.p,{children:"the id if the object should be collected, if it shouldnt be collected then it will return null or false."}),"\n",(0,s.jsx)(n.h4,{id:"see-1",children:"See"}),"\n",(0,s.jsx)(n.p,{children:"Collector#handleCollect"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-1",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destroy"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Destroys all assets used by the base client."}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Handles incoming events from the ",(0,s.jsx)(n.code,{children:"handleDispose"}),". Returns null if the event should not\nbe disposed, or returns the key that should be removed."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Any args the event listener emits"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Key to remove from the collection, if any"}),"\n",(0,s.jsx)(n.h4,{id:"see-2",children:"See"}),"\n",(0,s.jsx)(n.p,{children:"Collector#handleDispose"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-2",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"emit"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,s.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns ",(0,s.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.emit"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endreason",children:"endReason()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"endReason"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector has ended or will end with."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Reason to end the collector, if any"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-3",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,s.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["(",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.eventNames"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.getMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlecollect",children:"handleCollect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleCollect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to handle an event as a collectable element. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#collect"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handledispose",children:"handleDispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleDispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to remove an element from the collection. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-1",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#dispose"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listenerCount"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"off"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.off"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.on"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.prependListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"})," to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.prependOnceListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rawListeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,s.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-11",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.rawListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,s.jsx)(n.code,{children:"event"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event?"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-12",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.removeAllListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes the specified ",(0,s.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,s.jsx)(n.code,{children:"eventName"}),", then ",(0,s.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,s.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,s.jsx)(n.code,{children:"removeListener()"})," or ",(0,s.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,s.jsx)(n.em,{children:"after"})," emitting and ",(0,s.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,s.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,s.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,s.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,s.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,s.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,s.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-13",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.removeListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resettimer",children:"resetTimer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"resetTimer"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Resets the collectors timeout and idle timer."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"})," = ",(0,s.jsx)(n.code,{children:"..."})]}),"\n",(0,s.jsx)(n.p,{children:"Options"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.idle?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to stop the collector after inactivity in milliseconds"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.time?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to run the collector for in milliseconds"}),"\n",(0,s.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setimmediate",children:"setImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setImmediate"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an immediate that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Immediate"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setinterval",children:"setInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setInterval"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an interval that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait between executions (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["By default ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,s.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,s.jsx)(n.code,{children:"Infinity"})," (or ",(0,s.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-14",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.setMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settimeout",children:"setTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setTimeout"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets a timeout that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait before executing (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"reason"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Stops this collector and emits the ",(0,s.jsx)(n.code,{children:"end"})," event."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"reason?"}),": ",(0,s.jsx)(n.code,{children:"string"})," = ",(0,s.jsx)(n.code,{children:"'user'"})]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector is ending"}),"\n",(0,s.jsx)(n.h4,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"emits-2",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#end"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"name"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,s.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-15",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.getEventListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount-1",children:(0,s.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,s.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,s.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-16",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,s.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,s.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,s.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listenerCount"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns an ",(0,s.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,s.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,s.jsx)(n.code,{children:"emitter"})]}),"\n",(0,s.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.on"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Creates a ",(0,s.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,s.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,s.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,s.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,s.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,s.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The special handling of the ",(0,s.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,s.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,s.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,s.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"since-18",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"?, ...",(0,s.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n?"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,s.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"since-19",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.setMaxListeners"})})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>c});var s=r(6540);const i={},t=s.createContext(i);function l(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f22ab3cc.5719f9c8.js b/assets/js/f22ab3cc.5719f9c8.js new file mode 100644 index 0000000000..05b9244ffb --- /dev/null +++ b/assets/js/f22ab3cc.5719f9c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[583],{8590:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=r(4848),i=r(8453);const t={},l="Class: Collector",c={id:"reference/structures/Collector/classes/Collector",title:"Class: Collector",description:"Abstract class for defining a new Collector.",source:"@site/docs/reference/structures/Collector/classes/Collector.md",sourceDirName:"reference/structures/Collector/classes",slug:"/reference/structures/Collector/classes/Collector",permalink:"/docs/reference/structures/Collector/classes/Collector",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/classes/Collector.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: Collection\\",permalink:"/docs/reference/structures/Collector/classes/Collection"},next:{title:"Interface: AwaitMessagesOptions",permalink:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions"}},d={},o=[{value:"Abstract",id:"abstract",level:2},{value:"Extends",id:"extends",level:2},{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Collector()",id:"new-collector",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_idletimeout",id:"_idletimeout",level:3},{value:"_timeout",id:"_timeout",level:3},{value:"collected",id:"collected",level:3},{value:"ended",id:"ended",level:3},{value:"filter()",id:"filter",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"options",id:"options",level:3},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Accessors",id:"accessors",level:2},{value:"next",id:"next",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Methods",id:"methods",level:2},{value:"[asyncIterator]()",id:"asynciterator",level:3},{value:"Returns",id:"returns-3",level:4},{value:"See",id:"see",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"checkEnd()",id:"checkend",level:3},{value:"Returns",id:"returns-5",level:4},{value:"clearImmediate()",id:"clearimmediate",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"clearInterval()",id:"clearinterval",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"clearTimeout()",id:"cleartimeout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"collect()",id:"collect",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-9",level:4},{value:"See",id:"see-1",level:4},{value:"Abstract",id:"abstract-1",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Returns",id:"returns-10",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-11",level:4},{value:"See",id:"see-2",level:4},{value:"Abstract",id:"abstract-2",level:4},{value:"emit()",id:"emit",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"endReason()",id:"endreason",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Abstract",id:"abstract-3",level:4},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"handleCollect()",id:"handlecollect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Emits",id:"emits",level:4},{value:"handleDispose()",id:"handledispose",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Emits",id:"emits-1",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"on()",id:"on",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"once()",id:"once",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Since",id:"since-11",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-12",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-13",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"resetTimer()",id:"resettimer",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-28",level:4},{value:"setImmediate()",id:"setimmediate",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-29",level:4},{value:"setInterval()",id:"setinterval",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-30",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Since",id:"since-14",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"setTimeout()",id:"settimeout",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-32",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Emits",id:"emits-2",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Since",id:"since-15",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Since",id:"since-16",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-18",level:5},{value:"Inherited from",id:"inherited-from-22",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Inherited from",id:"inherited-from-23",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Since",id:"since-19",level:4},{value:"Inherited from",id:"inherited-from-24",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"class-collector",children:"Class: Collector"})}),"\n",(0,s.jsx)(n.p,{children:"Abstract class for defining a new Collector."}),"\n",(0,s.jsx)(n.h2,{id:"abstract",children:"Abstract"}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"EventEmitter"})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,s.jsx)(n.code,{children:"MessageCollector"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-collector",children:"new Collector()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collector"}),"(",(0,s.jsx)(n.code,{children:"filter"}),", ",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filter"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,s.jsx)(n.code,{children:"CollectorFilter"})}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})," = ",(0,s.jsx)(n.code,{children:"{}"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector",children:(0,s.jsx)(n.code,{children:"Collector"})})}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.constructor"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"_idletimeout",children:"_idletimeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_idletimeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_timeout",children:"_timeout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"protected"})," ",(0,s.jsx)(n.strong,{children:"_timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collected",children:"collected"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collected"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ended",children:"ended"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ended"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),": (...",(0,s.jsx)(n.code,{children:"args"}),") => ",(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,s.jsx)(n.code,{children:"CollectorOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,s.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.captureRejectionSymbol"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"captureRejections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.captureRejections"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.defaultMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,s.jsx)(n.em,{children:"typeof"})," ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,s.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,s.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,s.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,s.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,s.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,s.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.errorMonitor"})}),"\n",(0,s.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,s.jsx)(n.h3,{id:"next",children:"next"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"get"})," ",(0,s.jsx)(n.strong,{children:"next"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a promise that resolves with the next collected element;\nrejects with collected elements if the collector finishes without receiving a next element"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"asynciterator",children:"[asyncIterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[asyncIterator]"}),"(): ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Allows collectors to be consumed with for-await-of loops"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\n",(0,s.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of",children:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"addListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.addListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"checkend",children:"checkEnd()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"checkEnd"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks whether the collector should end, and if so, ends it."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearimmediate",children:"clearImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearImmediate"}),"(",(0,s.jsx)(n.code,{children:"immediate"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an immediate."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"immediate"}),": ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n",(0,s.jsx)(n.p,{children:"Immediate to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clearinterval",children:"clearInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearInterval"}),"(",(0,s.jsx)(n.code,{children:"interval"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears an interval."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"interval"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Interval to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cleartimeout",children:"clearTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clearTimeout"}),"(",(0,s.jsx)(n.code,{children:"timeout"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Clears a timeout."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"timeout"}),": ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to cancel"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"collect",children:"collect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"collect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Handles incoming events from the ",(0,s.jsx)(n.code,{children:"handleCollect"})," function. Returns null if the event should not\nbe collected, or returns an object describing the data that should be stored."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.p,{children:"the id if the object should be collected, if it shouldnt be collected then it will return null or false."}),"\n",(0,s.jsx)(n.h4,{id:"see-1",children:"See"}),"\n",(0,s.jsx)(n.p,{children:"Collector#handleCollect"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-1",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destroy"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Destroys all assets used by the base client."}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Handles incoming events from the ",(0,s.jsx)(n.code,{children:"handleDispose"}),". Returns null if the event should not\nbe disposed, or returns the key that should be removed."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Any args the event listener emits"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Key to remove from the collection, if any"}),"\n",(0,s.jsx)(n.h4,{id:"see-2",children:"See"}),"\n",(0,s.jsx)(n.p,{children:"Collector#handleDispose"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-2",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"emit"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,s.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns ",(0,s.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.emit"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endreason",children:"endReason()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"endReason"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector has ended or will end with."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Reason to end the collector, if any"}),"\n",(0,s.jsx)(n.h4,{id:"abstract-3",children:"Abstract"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,s.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["(",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.eventNames"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.getMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handlecollect",children:"handleCollect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleCollect"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to handle an event as a collectable element. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#collect"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"handledispose",children:"handleDispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"handleDispose"}),"(...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Call this to remove an element from the collection. Accepts any event data as parameters."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The arguments emitted by the listener"}),"\n",(0,s.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"emits-1",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#dispose"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listenerCount"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"off"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Alias for ",(0,s.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.off"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.on"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,s.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds the ",(0,s.jsx)(n.code,{children:"listener"})," function to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,s.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,s.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,s.jsx)(n.code,{children:"eventName"}),"and ",(0,s.jsx)(n.code,{children:"listener"})," will result in the ",(0,s.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.prependListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Adds a ",(0,s.jsx)(n.strong,{children:"one-time"}),(0,s.jsx)(n.code,{children:"listener"})," function for the event named ",(0,s.jsx)(n.code,{children:"eventName"})," to the ",(0,s.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,s.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The callback function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.prependOnceListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rawListeners"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,s.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-11",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.rawListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,s.jsx)(n.code,{children:"event"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"event?"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-12",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.removeAllListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeListener"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"listener"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Removes the specified ",(0,s.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,s.jsx)(n.code,{children:"eventName"}),", then ",(0,s.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,s.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,s.jsx)(n.code,{children:"removeListener()"})," or ",(0,s.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,s.jsx)(n.em,{children:"after"})," emitting and ",(0,s.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,s.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,s.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,s.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,s.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,s.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,s.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-13",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.removeListener"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resettimer",children:"resetTimer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"resetTimer"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Resets the collectors timeout and idle timer."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"})," = ",(0,s.jsx)(n.code,{children:"..."})]}),"\n",(0,s.jsx)(n.p,{children:"Options"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.idle?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to stop the collector after inactivity in milliseconds"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options.time?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"How long to run the collector for in milliseconds"}),"\n",(0,s.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setimmediate",children:"setImmediate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setImmediate"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Immediate"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an immediate that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Immediate"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setinterval",children:"setInterval()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setInterval"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets an interval that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait between executions (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["By default ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,s.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,s.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,s.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,s.jsx)(n.code,{children:"Infinity"})," (or ",(0,s.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a reference to the ",(0,s.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"since-14",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.setMaxListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settimeout",children:"setTimeout()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setTimeout"}),"(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"delay"}),", ...",(0,s.jsx)(n.code,{children:"args"}),"): ",(0,s.jsx)(n.code,{children:"Timeout"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets a timeout that will be automatically cancelled if the client is destroyed."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"delay"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Time to wait before executing (in milliseconds)"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"args"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments for the function"}),"\n",(0,s.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Timeout"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"reason"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Stops this collector and emits the ",(0,s.jsx)(n.code,{children:"end"})," event."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"reason?"}),": ",(0,s.jsx)(n.code,{children:"string"})," = ",(0,s.jsx)(n.code,{children:"'user'"})]}),"\n",(0,s.jsx)(n.p,{children:"The reason this collector is ending"}),"\n",(0,s.jsx)(n.h4,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"emits-2",children:"Emits"}),"\n",(0,s.jsx)(n.p,{children:"Collector#end"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"name"}),"): ",(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,s.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,s.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,s.jsxs)(n.p,{children:["For ",(0,s.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"since-15",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.getEventListeners"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"listenercount-1",children:(0,s.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"listenerCount"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,s.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,s.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h4,{id:"since-16",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,s.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,s.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,s.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.listenerCount"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"on"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns an ",(0,s.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,s.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["that iterates ",(0,s.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,s.jsx)(n.code,{children:"emitter"})]}),"\n",(0,s.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.on"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Creates a ",(0,s.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,s.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,s.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,s.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,s.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,s.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,s.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,s.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The special handling of the ",(0,s.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,s.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,s.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,s.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,s.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"symbol"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"since-18",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"once"}),"(",(0,s.jsx)(n.code,{children:"emitter"}),", ",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"emitter"}),": ",(0,s.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.once"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,s.jsx)(n.code,{children:"n"}),"?, ...",(0,s.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"n?"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,s.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,s.jsx)(n.code,{children:"EventEmitter"})," | ",(0,s.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"since-19",children:"Since"}),"\n",(0,s.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"EventEmitter.setMaxListeners"})})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>c});var s=r(6540);const i={},t=s.createContext(i);function l(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f38ef2c2.c3041403.js b/assets/js/f38ef2c2.c3041403.js deleted file mode 100644 index 30288454b2..0000000000 --- a/assets/js/f38ef2c2.c3041403.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6052],{4500:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>u});var r=t(4848),s=t(8453);const a={},o="Variable: useragent",i={id:"reference/api/Client/variables/useragent",title:"Variable: useragent",description:"const useragent: string",source:"@site/docs/reference/api/Client/variables/useragent.md",sourceDirName:"reference/api/Client/variables",slug:"/reference/api/Client/variables/useragent",permalink:"/docs/reference/api/Client/variables/useragent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/variables/useragent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"},next:{title:"api/functions/exposed.enum",permalink:"/docs/reference/api/functions/exposed.enum/"}},c={},u=[];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-useragent",children:"Variable: useragent"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"useragent"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>i});var r=t(6540);const s={},a=r.createContext(s);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f38ef2c2.db37bc96.js b/assets/js/f38ef2c2.db37bc96.js new file mode 100644 index 0000000000..ee4b99776c --- /dev/null +++ b/assets/js/f38ef2c2.db37bc96.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6052],{4500:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>u});var r=t(4848),s=t(8453);const a={},i="Variable: useragent",o={id:"reference/api/Client/variables/useragent",title:"Variable: useragent",description:"const useragent: string",source:"@site/docs/reference/api/Client/variables/useragent.md",sourceDirName:"reference/api/Client/variables",slug:"/reference/api/Client/variables/useragent",permalink:"/docs/reference/api/Client/variables/useragent",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/variables/useragent.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"},next:{title:"api/functions/exposed.enum",permalink:"/docs/reference/api/functions/exposed.enum/"}},c={},u=[];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"variable-useragent",children:"Variable: useragent"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"useragent"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function i(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f3df8bb0.a1c04efe.js b/assets/js/f3df8bb0.a1c04efe.js deleted file mode 100644 index 6e99118673..0000000000 --- a/assets/js/f3df8bb0.a1c04efe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8924],{5923:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>d});var r=s(4848),c=s(8453);const o={},i="Enumeration: MessageAck",t={id:"reference/api/model/message/enumerations/MessageAck",title:"Enumeration: MessageAck",description:"Message ACK",source:"@site/docs/reference/api/model/message/enumerations/MessageAck.md",sourceDirName:"reference/api/model/message/enumerations",slug:"/reference/api/model/message/enumerations/MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/enumerations/MessageAck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/message",permalink:"/docs/reference/api/model/message/"},next:{title:"Enumeration: MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes"}},a={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ACK_DEVICE",id:"ack_device",level:3},{value:"ACK_ERROR",id:"ack_error",level:3},{value:"ACK_PENDING",id:"ack_pending",level:3},{value:"ACK_PLAYED",id:"ack_played",level:3},{value:"ACK_READ",id:"ack_read",level:3},{value:"ACK_SERVER",id:"ack_server",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-messageack",children:"Enumeration: MessageAck"}),"\n",(0,r.jsx)(n.p,{children:"Message ACK"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"ack_device",children:"ACK_DEVICE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_DEVICE"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_error",children:"ACK_ERROR"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_ERROR"}),": ",(0,r.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_pending",children:"ACK_PENDING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_PENDING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_played",children:"ACK_PLAYED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_PLAYED"}),": ",(0,r.jsx)(n.code,{children:"4"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_read",children:"ACK_READ"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_READ"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_server",children:"ACK_SERVER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_SERVER"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>t});var r=s(6540);const c={},o=r.createContext(c);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f3df8bb0.ebe2b092.js b/assets/js/f3df8bb0.ebe2b092.js new file mode 100644 index 0000000000..dc8a9e84c1 --- /dev/null +++ b/assets/js/f3df8bb0.ebe2b092.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8924],{5923:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(4848),c=s(8453);const i={},o="Enumeration: MessageAck",a={id:"reference/api/model/message/enumerations/MessageAck",title:"Enumeration: MessageAck",description:"Message ACK",source:"@site/docs/reference/api/model/message/enumerations/MessageAck.md",sourceDirName:"reference/api/model/message/enumerations",slug:"/reference/api/model/message/enumerations/MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/enumerations/MessageAck.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/message",permalink:"/docs/reference/api/model/message/"},next:{title:"Enumeration: MessageTypes",permalink:"/docs/reference/api/model/message/enumerations/MessageTypes"}},t={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ACK_DEVICE",id:"ack_device",level:3},{value:"ACK_ERROR",id:"ack_error",level:3},{value:"ACK_PENDING",id:"ack_pending",level:3},{value:"ACK_PLAYED",id:"ack_played",level:3},{value:"ACK_READ",id:"ack_read",level:3},{value:"ACK_SERVER",id:"ack_server",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-messageack",children:"Enumeration: MessageAck"})}),"\n",(0,r.jsx)(n.p,{children:"Message ACK"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"ack_device",children:"ACK_DEVICE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_DEVICE"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_error",children:"ACK_ERROR"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_ERROR"}),": ",(0,r.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_pending",children:"ACK_PENDING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_PENDING"}),": ",(0,r.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_played",children:"ACK_PLAYED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_PLAYED"}),": ",(0,r.jsx)(n.code,{children:"4"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_read",children:"ACK_READ"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_READ"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ack_server",children:"ACK_SERVER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACK_SERVER"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var r=s(6540);const c={},i=r.createContext(c);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f3fdb01a.7e871094.js b/assets/js/f3fdb01a.7e871094.js new file mode 100644 index 0000000000..aec52c3f13 --- /dev/null +++ b/assets/js/f3fdb01a.7e871094.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52],{5255:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var t=s(4848),n=s(8453);const i={},r="Type Alias: AdvancedFile",c={id:"reference/api/model/aliases/type-aliases/AdvancedFile",title:"Type Alias: AdvancedFile",description:"AdvancedFile: DataURL \\| FilePath \\| GetURL",source:"@site/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber"},next:{title:"Type Alias: Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64"}},l={},o=[];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(a.header,{children:(0,t.jsx)(a.h1,{id:"type-alias-advancedfile",children:"Type Alias: AdvancedFile"})}),"\n",(0,t.jsxs)(a.blockquote,{children:["\n",(0,t.jsxs)(a.p,{children:[(0,t.jsx)(a.strong,{children:"AdvancedFile"}),": ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,t.jsx)(a.code,{children:"DataURL"})})," | ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:(0,t.jsx)(a.code,{children:"FilePath"})})," | ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:(0,t.jsx)(a.code,{children:"GetURL"})})]}),"\n"]}),"\n",(0,t.jsx)(a.p,{children:"Some file based actions in open-wa are powerful enough to take a dataurl, url or filepath"})]})}function p(e={}){const{wrapper:a}={...(0,n.R)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,a,s)=>{s.d(a,{R:()=>r,x:()=>c});var t=s(6540);const n={},i=t.createContext(n);function r(e){const a=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function c(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),t.createElement(i.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f3fdb01a.b9fd4875.js b/assets/js/f3fdb01a.b9fd4875.js deleted file mode 100644 index d378ab9697..0000000000 --- a/assets/js/f3fdb01a.b9fd4875.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52],{5255:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var t=s(4848),n=s(8453);const i={},r="Type Alias: AdvancedFile",c={id:"reference/api/model/aliases/type-aliases/AdvancedFile",title:"Type Alias: AdvancedFile",description:"AdvancedFile: DataURL \\| FilePath \\| GetURL",source:"@site/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",sourceDirName:"reference/api/model/aliases/type-aliases",slug:"/reference/api/model/aliases/type-aliases/AdvancedFile",permalink:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber"},next:{title:"Type Alias: Base64",permalink:"/docs/reference/api/model/aliases/type-aliases/Base64"}},l={},o=[];function d(e){const a={a:"a",blockquote:"blockquote",code:"code",h1:"h1",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(a.h1,{id:"type-alias-advancedfile",children:"Type Alias: AdvancedFile"}),"\n",(0,t.jsxs)(a.blockquote,{children:["\n",(0,t.jsxs)(a.p,{children:[(0,t.jsx)(a.strong,{children:"AdvancedFile"}),": ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,t.jsx)(a.code,{children:"DataURL"})})," | ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:(0,t.jsx)(a.code,{children:"FilePath"})})," | ",(0,t.jsx)(a.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:(0,t.jsx)(a.code,{children:"GetURL"})})]}),"\n"]}),"\n",(0,t.jsx)(a.p,{children:"Some file based actions in open-wa are powerful enough to take a dataurl, url or filepath"})]})}function p(e={}){const{wrapper:a}={...(0,n.R)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,a,s)=>{s.d(a,{R:()=>r,x:()=>c});var t=s(6540);const n={},i=t.createContext(n);function r(e){const a=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function c(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),t.createElement(i.Provider,{value:a},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f47e5abf.81af7f60.js b/assets/js/f47e5abf.81af7f60.js deleted file mode 100644 index 6ad20f2d50..0000000000 --- a/assets/js/f47e5abf.81af7f60.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1619],{9601:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>t,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=l(4848),s=l(8453);const c={},i="Enumeration: CallState",o={id:"reference/api/model/call/enumerations/CallState",title:"Enumeration: CallState",description:"Enumeration Members",source:"@site/docs/reference/api/model/call/enumerations/CallState.md",sourceDirName:"reference/api/model/call/enumerations",slug:"/reference/api/model/call/enumerations/CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/enumerations/CallState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/call",permalink:"/docs/reference/api/model/call/"},next:{title:"Interface: Call",permalink:"/docs/reference/api/model/call/interfaces/Call"}},t={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ACTIVE",id:"active",level:3},{value:"CONNECTING",id:"connecting",level:3},{value:"CONNECTION_LOST",id:"connection_lost",level:3},{value:"ENDED",id:"ended",level:3},{value:"FAILED",id:"failed",level:3},{value:"HANDLED_REMOTELY",id:"handled_remotely",level:3},{value:"INCOMING_RING",id:"incoming_ring",level:3},{value:"NOT_ANSWERED",id:"not_answered",level:3},{value:"OUTGOING_CALLING",id:"outgoing_calling",level:3},{value:"OUTGOING_RING",id:"outgoing_ring",level:3},{value:"REJECTED",id:"rejected",level:3},{value:"REMOTE_CALL_IN_PROGRESS",id:"remote_call_in_progress",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-callstate",children:"Enumeration: CallState"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"active",children:"ACTIVE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACTIVE"}),": ",(0,r.jsx)(n.code,{children:'"ACTIVE"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"connecting",children:"CONNECTING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONNECTING"}),": ",(0,r.jsx)(n.code,{children:'"CONNECTING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"connection_lost",children:"CONNECTION_LOST"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONNECTION_LOST"}),": ",(0,r.jsx)(n.code,{children:'"CONNECTION_LOST"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ended",children:"ENDED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ENDED"}),": ",(0,r.jsx)(n.code,{children:'"ENDED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"failed",children:"FAILED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"FAILED"}),": ",(0,r.jsx)(n.code,{children:'"FAILED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"handled_remotely",children:"HANDLED_REMOTELY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"HANDLED_REMOTELY"}),": ",(0,r.jsx)(n.code,{children:'"HANDLED_REMOTELY"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"incoming_ring",children:"INCOMING_RING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"INCOMING_RING"}),": ",(0,r.jsx)(n.code,{children:'"INCOMING_RING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"not_answered",children:"NOT_ANSWERED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NOT_ANSWERED"}),": ",(0,r.jsx)(n.code,{children:'"NOT_ANSWERED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"outgoing_calling",children:"OUTGOING_CALLING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"OUTGOING_CALLING"}),": ",(0,r.jsx)(n.code,{children:'"OUTGOING_CALLING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"outgoing_ring",children:"OUTGOING_RING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"OUTGOING_RING"}),": ",(0,r.jsx)(n.code,{children:'"OUTGOING_RING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rejected",children:"REJECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REJECTED"}),": ",(0,r.jsx)(n.code,{children:'"REJECTED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"remote_call_in_progress",children:"REMOTE_CALL_IN_PROGRESS"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REMOTE_CALL_IN_PROGRESS"}),": ",(0,r.jsx)(n.code,{children:'"REMOTE_CALL_IN_PROGRESS"'})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>o});var r=l(6540);const s={},c=r.createContext(s);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f47e5abf.aef40189.js b/assets/js/f47e5abf.aef40189.js new file mode 100644 index 0000000000..d1d4cacc58 --- /dev/null +++ b/assets/js/f47e5abf.aef40189.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1619],{9601:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>t,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=l(4848),s=l(8453);const c={},i="Enumeration: CallState",o={id:"reference/api/model/call/enumerations/CallState",title:"Enumeration: CallState",description:"Enumeration Members",source:"@site/docs/reference/api/model/call/enumerations/CallState.md",sourceDirName:"reference/api/model/call/enumerations",slug:"/reference/api/model/call/enumerations/CallState",permalink:"/docs/reference/api/model/call/enumerations/CallState",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/call/enumerations/CallState.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/call",permalink:"/docs/reference/api/model/call/"},next:{title:"Interface: Call",permalink:"/docs/reference/api/model/call/interfaces/Call"}},t={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ACTIVE",id:"active",level:3},{value:"CONNECTING",id:"connecting",level:3},{value:"CONNECTION_LOST",id:"connection_lost",level:3},{value:"ENDED",id:"ended",level:3},{value:"FAILED",id:"failed",level:3},{value:"HANDLED_REMOTELY",id:"handled_remotely",level:3},{value:"INCOMING_RING",id:"incoming_ring",level:3},{value:"NOT_ANSWERED",id:"not_answered",level:3},{value:"OUTGOING_CALLING",id:"outgoing_calling",level:3},{value:"OUTGOING_RING",id:"outgoing_ring",level:3},{value:"REJECTED",id:"rejected",level:3},{value:"REMOTE_CALL_IN_PROGRESS",id:"remote_call_in_progress",level:3}];function a(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-callstate",children:"Enumeration: CallState"})}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"active",children:"ACTIVE"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ACTIVE"}),": ",(0,r.jsx)(n.code,{children:'"ACTIVE"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"connecting",children:"CONNECTING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONNECTING"}),": ",(0,r.jsx)(n.code,{children:'"CONNECTING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"connection_lost",children:"CONNECTION_LOST"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"CONNECTION_LOST"}),": ",(0,r.jsx)(n.code,{children:'"CONNECTION_LOST"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ended",children:"ENDED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ENDED"}),": ",(0,r.jsx)(n.code,{children:'"ENDED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"failed",children:"FAILED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"FAILED"}),": ",(0,r.jsx)(n.code,{children:'"FAILED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"handled_remotely",children:"HANDLED_REMOTELY"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"HANDLED_REMOTELY"}),": ",(0,r.jsx)(n.code,{children:'"HANDLED_REMOTELY"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"incoming_ring",children:"INCOMING_RING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"INCOMING_RING"}),": ",(0,r.jsx)(n.code,{children:'"INCOMING_RING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"not_answered",children:"NOT_ANSWERED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"NOT_ANSWERED"}),": ",(0,r.jsx)(n.code,{children:'"NOT_ANSWERED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"outgoing_calling",children:"OUTGOING_CALLING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"OUTGOING_CALLING"}),": ",(0,r.jsx)(n.code,{children:'"OUTGOING_CALLING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"outgoing_ring",children:"OUTGOING_RING"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"OUTGOING_RING"}),": ",(0,r.jsx)(n.code,{children:'"OUTGOING_RING"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rejected",children:"REJECTED"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REJECTED"}),": ",(0,r.jsx)(n.code,{children:'"REJECTED"'})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"remote_call_in_progress",children:"REMOTE_CALL_IN_PROGRESS"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"REMOTE_CALL_IN_PROGRESS"}),": ",(0,r.jsx)(n.code,{children:'"REMOTE_CALL_IN_PROGRESS"'})]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>o});var r=l(6540);const s={},c=r.createContext(s);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4e478b9.0a57b1bd.js b/assets/js/f4e478b9.0a57b1bd.js new file mode 100644 index 0000000000..8fb2959586 --- /dev/null +++ b/assets/js/f4e478b9.0a57b1bd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5136],{2399:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var r=t(4848),o=t(8453);const s={},c="Interface: PollOption",l={id:"reference/api/model/message/interfaces/PollOption",title:"Interface: PollOption",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollOption.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollOption.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData"},next:{title:"Interface: PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote"}},i={},a=[{value:"Properties",id:"properties",level:2},{value:"localId",id:"localid",level:3},{value:"name",id:"name",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-polloption",children:"Interface: PollOption"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"localid",children:"localId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"localId"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>l});var r=t(6540);const o={},s=r.createContext(o);function c(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4e478b9.291f2ebc.js b/assets/js/f4e478b9.291f2ebc.js deleted file mode 100644 index ba56ba128d..0000000000 --- a/assets/js/f4e478b9.291f2ebc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5136],{2399:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=t(4848),r=t(8453);const s={},c="Interface: PollOption",l={id:"reference/api/model/message/interfaces/PollOption",title:"Interface: PollOption",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/PollOption.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/PollOption",permalink:"/docs/reference/api/model/message/interfaces/PollOption",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/PollOption.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: PollData",permalink:"/docs/reference/api/model/message/interfaces/PollData"},next:{title:"Interface: PollVote",permalink:"/docs/reference/api/model/message/interfaces/PollVote"}},i={},a=[{value:"Properties",id:"properties",level:2},{value:"localId",id:"localid",level:3},{value:"name",id:"name",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-polloption",children:"Interface: PollOption"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"localid",children:"localId"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"localId"}),": ",(0,o.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"name"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>l});var o=t(6540);const r={},s=o.createContext(r);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4f34a3a.4b29f9eb.js b/assets/js/f4f34a3a.4b29f9eb.js new file mode 100644 index 0000000000..eaf96d5f9f --- /dev/null +++ b/assets/js/f4f34a3a.4b29f9eb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3637],{5512:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=o(4848),n=o(8453);const r={slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},a=void 0,c={permalink:"/blog/mdx-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx",source:"@site/blog/2021-08-01-mdx-blog-post.mdx",title:"MDX Blog Post",description:"Blog posts support Docusaurus Markdown features, such as MDX.",date:"2021-08-01T00:00:00.000Z",tags:[{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.175,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber",page:null}],frontMatter:{slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},unlisted:!1,prevItem:{title:"Welcome",permalink:"/blog/welcome"},nextItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},u={authorsImageUrls:[void 0]},l=[];function i(t){const e={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,n.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(e.p,{children:["Blog posts support ",(0,s.jsx)(e.a,{href:"https://docusaurus.io/docs/markdown-features",children:"Docusaurus Markdown features"}),", such as ",(0,s.jsx)(e.a,{href:"https://mdxjs.com/",children:"MDX"}),"."]}),"\n",(0,s.jsxs)(e.admonition,{type:"tip",children:[(0,s.jsx)(e.p,{children:"Use the power of React to create interactive blog posts."}),(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-js",children:"\n"})}),(0,s.jsx)("button",{onClick:()=>alert("button clicked!"),children:"Click me!"})]})]})}function d(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(i,{...t})}):i(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>c});var s=o(6540);const n={},r=s.createContext(n);function a(t){const e=s.useContext(r);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:a(t.components),s.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4f34a3a.507bc12a.js b/assets/js/f4f34a3a.507bc12a.js deleted file mode 100644 index e13eed636e..0000000000 --- a/assets/js/f4f34a3a.507bc12a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3637],{5512:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>n,metadata:()=>c,toc:()=>l});var s=o(4848),r=o(8453);const n={slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},a=void 0,c={permalink:"/blog/mdx-blog-post",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx",source:"@site/blog/2021-08-01-mdx-blog-post.mdx",title:"MDX Blog Post",description:"Blog posts support Docusaurus Markdown features, such as MDX.",date:"2021-08-01T00:00:00.000Z",tags:[{inline:!1,label:"Docusaurus",permalink:"/blog/tags/docusaurus",description:"Docusaurus tag description"}],readingTime:.175,hasTruncateMarker:!1,authors:[{name:"S\xe9bastien Lorber",title:"Docusaurus maintainer",url:"https://sebastienlorber.com",imageURL:"https://github.com/slorber.png",key:"slorber"}],frontMatter:{slug:"mdx-blog-post",title:"MDX Blog Post",authors:["slorber"],tags:["docusaurus"]},unlisted:!1,prevItem:{title:"Welcome",permalink:"/blog/welcome"},nextItem:{title:"Long Blog Post",permalink:"/blog/long-blog-post"}},u={authorsImageUrls:[void 0]},l=[];function i(t){const e={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,r.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(e.p,{children:["Blog posts support ",(0,s.jsx)(e.a,{href:"https://docusaurus.io/docs/markdown-features",children:"Docusaurus Markdown features"}),", such as ",(0,s.jsx)(e.a,{href:"https://mdxjs.com/",children:"MDX"}),"."]}),"\n",(0,s.jsxs)(e.admonition,{type:"tip",children:[(0,s.jsx)(e.p,{children:"Use the power of React to create interactive blog posts."}),(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-js",children:"\n"})}),(0,s.jsx)("button",{onClick:()=>alert("button clicked!"),children:"Click me!"})]})]})}function d(t={}){const{wrapper:e}={...(0,r.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(i,{...t})}):i(t)}},8453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>c});var s=o(6540);const r={},n=s.createContext(r);function a(t){const e=s.useContext(n);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(r):t.components||r:a(t.components),s.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/f55d3e7a.39226115.js b/assets/js/f55d3e7a.39226115.js deleted file mode 100644 index bcbbd1cc78..0000000000 --- a/assets/js/f55d3e7a.39226115.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8863],{745:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=t(4848),o=t(8453);const i={sidebar_position:5},n="Deploy your site",l={id:"tutorial-basics/deploy-your-site",title:"Deploy your site",description:"Docusaurus is a static-site-generator (also called Jamstack).",source:"@site/docs/tutorial-basics/deploy-your-site.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/deploy-your-site",permalink:"/docs/tutorial-basics/deploy-your-site",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/deploy-your-site.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Markdown Features",permalink:"/docs/tutorial-basics/markdown-features"},next:{title:"Congratulations!",permalink:"/docs/tutorial-basics/congratulations"}},a={},c=[{value:"Build your site",id:"build-your-site",level:2},{value:"Deploy your site",id:"deploy-your-site-1",level:2}];function d(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"deploy-your-site",children:"Deploy your site"}),"\n",(0,r.jsxs)(s.p,{children:["Docusaurus is a ",(0,r.jsx)(s.strong,{children:"static-site-generator"})," (also called ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://jamstack.org/",children:"Jamstack"})}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["It builds your site as simple ",(0,r.jsx)(s.strong,{children:"static HTML, JavaScript and CSS files"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"build-your-site",children:"Build your site"}),"\n",(0,r.jsxs)(s.p,{children:["Build your site ",(0,r.jsx)(s.strong,{children:"for production"}),":"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"npm run build\n"})}),"\n",(0,r.jsxs)(s.p,{children:["The static files are generated in the ",(0,r.jsx)(s.code,{children:"build"})," folder."]}),"\n",(0,r.jsx)(s.h2,{id:"deploy-your-site-1",children:"Deploy your site"}),"\n",(0,r.jsx)(s.p,{children:"Test your production build locally:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"npm run serve\n"})}),"\n",(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"build"})," folder is now served at ",(0,r.jsx)(s.a,{href:"http://localhost:3000/",children:"http://localhost:3000/"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["You can now deploy the ",(0,r.jsx)(s.code,{children:"build"})," folder ",(0,r.jsx)(s.strong,{children:"almost anywhere"})," easily, ",(0,r.jsx)(s.strong,{children:"for free"})," or very small cost (read the ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://docusaurus.io/docs/deployment",children:"Deployment Guide"})}),")."]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>n,x:()=>l});var r=t(6540);const o={},i=r.createContext(o);function n(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:n(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f55d3e7a.4ed244b5.js b/assets/js/f55d3e7a.4ed244b5.js new file mode 100644 index 0000000000..f9b455c37e --- /dev/null +++ b/assets/js/f55d3e7a.4ed244b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8863],{745:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var r=t(4848),o=t(8453);const i={sidebar_position:5},n="Deploy your site",a={id:"tutorial-basics/deploy-your-site",title:"Deploy your site",description:"Docusaurus is a static-site-generator (also called Jamstack).",source:"@site/docs/tutorial-basics/deploy-your-site.md",sourceDirName:"tutorial-basics",slug:"/tutorial-basics/deploy-your-site",permalink:"/docs/tutorial-basics/deploy-your-site",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/tutorial-basics/deploy-your-site.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"Markdown Features",permalink:"/docs/tutorial-basics/markdown-features"},next:{title:"Congratulations!",permalink:"/docs/tutorial-basics/congratulations"}},l={},c=[{value:"Build your site",id:"build-your-site",level:2},{value:"Deploy your site",id:"deploy-your-site-1",level:2}];function d(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"deploy-your-site",children:"Deploy your site"})}),"\n",(0,r.jsxs)(s.p,{children:["Docusaurus is a ",(0,r.jsx)(s.strong,{children:"static-site-generator"})," (also called ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://jamstack.org/",children:"Jamstack"})}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["It builds your site as simple ",(0,r.jsx)(s.strong,{children:"static HTML, JavaScript and CSS files"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"build-your-site",children:"Build your site"}),"\n",(0,r.jsxs)(s.p,{children:["Build your site ",(0,r.jsx)(s.strong,{children:"for production"}),":"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"npm run build\n"})}),"\n",(0,r.jsxs)(s.p,{children:["The static files are generated in the ",(0,r.jsx)(s.code,{children:"build"})," folder."]}),"\n",(0,r.jsx)(s.h2,{id:"deploy-your-site-1",children:"Deploy your site"}),"\n",(0,r.jsx)(s.p,{children:"Test your production build locally:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"npm run serve\n"})}),"\n",(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"build"})," folder is now served at ",(0,r.jsx)(s.a,{href:"http://localhost:3000/",children:"http://localhost:3000/"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["You can now deploy the ",(0,r.jsx)(s.code,{children:"build"})," folder ",(0,r.jsx)(s.strong,{children:"almost anywhere"})," easily, ",(0,r.jsx)(s.strong,{children:"for free"})," or very small cost (read the ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://docusaurus.io/docs/deployment",children:"Deployment Guide"})}),")."]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,t)=>{t.d(s,{R:()=>n,x:()=>a});var r=t(6540);const o={},i=r.createContext(o);function n(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:n(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f5760147.7a84a6de.js b/assets/js/f5760147.7a84a6de.js deleted file mode 100644 index 4ddbe85dfb..0000000000 --- a/assets/js/f5760147.7a84a6de.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4941],{9557:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>c,contentTitle:()=>n,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>t});var i=a(4848),r=a(8453);const l={},n="api/model/aliases",d={id:"reference/api/model/aliases/index",title:"api/model/aliases",description:"Index",source:"@site/docs/reference/api/model/aliases/index.md",sourceDirName:"reference/api/model/aliases",slug:"/reference/api/model/aliases/",permalink:"/docs/reference/api/model/aliases/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model",permalink:"/docs/reference/api/model/"},next:{title:"Type Alias: AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber"}},c={},t=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3}];function o(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"apimodelaliases",children:"api/model/aliases"}),"\n",(0,i.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(s.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>n,x:()=>d});var i=a(6540);const r={},l=i.createContext(r);function n(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f5760147.af8bd080.js b/assets/js/f5760147.af8bd080.js new file mode 100644 index 0000000000..e21ff84eb8 --- /dev/null +++ b/assets/js/f5760147.af8bd080.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4941],{9557:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>c,contentTitle:()=>n,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>t});var i=a(4848),r=a(8453);const l={},n="api/model/aliases",d={id:"reference/api/model/aliases/index",title:"api/model/aliases",description:"Index",source:"@site/docs/reference/api/model/aliases/index.md",sourceDirName:"reference/api/model/aliases",slug:"/reference/api/model/aliases/",permalink:"/docs/reference/api/model/aliases/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/aliases/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model",permalink:"/docs/reference/api/model/"},next:{title:"Type Alias: AccountNumber",permalink:"/docs/reference/api/model/aliases/type-aliases/AccountNumber"}},c={},t=[{value:"Index",id:"index",level:2},{value:"Type Aliases",id:"type-aliases",level:3}];function o(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"apimodelaliases",children:"api/model/aliases"})}),"\n",(0,i.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,i.jsx)(s.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},8453:(e,s,a)=>{a.d(s,{R:()=>n,x:()=>d});var i=a(6540);const r={},l=i.createContext(r);function n(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f81c1134.06ae688e.js b/assets/js/f81c1134.06ae688e.js new file mode 100644 index 0000000000..a8de1ce878 --- /dev/null +++ b/assets/js/f81c1134.06ae688e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8130],{7735:e=>{e.exports=JSON.parse('{"archive":{"blogPosts":[{"id":"welcome","metadata":{"permalink":"/blog/welcome","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md","source":"@site/blog/2021-08-26-welcome/index.md","title":"Welcome","description":"Docusaurus blogging features are powered by the blog plugin.","date":"2021-08-26T00:00:00.000Z","tags":[{"inline":false,"label":"Facebook","permalink":"/blog/tags/facebook","description":"Facebook tag description"},{"inline":false,"label":"Hello","permalink":"/blog/tags/hello","description":"Hello tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.405,"hasTruncateMarker":false,"authors":[{"name":"S\xe9bastien Lorber","title":"Docusaurus maintainer","url":"https://sebastienlorber.com","imageURL":"https://github.com/slorber.png","key":"slorber","page":null},{"name":"Yangshun Tay","title":"Front End Engineer @ Facebook","url":"https://github.com/yangshun","imageURL":"https://github.com/yangshun.png","key":"yangshun","page":null}],"frontMatter":{"slug":"welcome","title":"Welcome","authors":["slorber","yangshun"],"tags":["facebook","hello","docusaurus"]},"unlisted":false,"nextItem":{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post"}},"content":"[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).\\n\\nSimply add Markdown files (or folders) to the `blog` directory.\\n\\nRegular blog authors can be added to `authors.yml`.\\n\\nThe blog post date can be extracted from filenames, such as:\\n\\n- `2019-05-30-welcome.md`\\n- `2019-05-30-welcome/index.md`\\n\\nA blog post folder can be convenient to co-locate blog post images:\\n\\n![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)\\n\\nThe blog supports tags as well!\\n\\n**And if you don\'t want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config."},{"id":"mdx-blog-post","metadata":{"permalink":"/blog/mdx-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx","source":"@site/blog/2021-08-01-mdx-blog-post.mdx","title":"MDX Blog Post","description":"Blog posts support Docusaurus Markdown features, such as MDX.","date":"2021-08-01T00:00:00.000Z","tags":[{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.175,"hasTruncateMarker":false,"authors":[{"name":"S\xe9bastien Lorber","title":"Docusaurus maintainer","url":"https://sebastienlorber.com","imageURL":"https://github.com/slorber.png","key":"slorber","page":null}],"frontMatter":{"slug":"mdx-blog-post","title":"MDX Blog Post","authors":["slorber"],"tags":["docusaurus"]},"unlisted":false,"prevItem":{"title":"Welcome","permalink":"/blog/welcome"},"nextItem":{"title":"Long Blog Post","permalink":"/blog/long-blog-post"}},"content":"Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).\\n\\n:::tip\\n\\nUse the power of React to create interactive blog posts.\\n\\n```js\\n\\n```\\n\\n\\n\\n:::"},{"id":"long-blog-post","metadata":{"permalink":"/blog/long-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md","source":"@site/blog/2019-05-29-long-blog-post.md","title":"Long Blog Post","description":"This is the summary of a very long blog post,","date":"2019-05-29T00:00:00.000Z","tags":[{"inline":false,"label":"Hello","permalink":"/blog/tags/hello","description":"Hello tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":2.05,"hasTruncateMarker":true,"authors":[{"name":"Endilie Yacop Sucipto","title":"Maintainer of Docusaurus","url":"https://github.com/endiliey","imageURL":"https://github.com/endiliey.png","key":"endi","page":null}],"frontMatter":{"slug":"long-blog-post","title":"Long Blog Post","authors":"endi","tags":["hello","docusaurus"]},"unlisted":false,"prevItem":{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post"},"nextItem":{"title":"First Blog Post","permalink":"/blog/first-blog-post"}},"content":"This is the summary of a very long blog post,\\n\\nUse a `\x3c!--` `truncate` `--\x3e` comment to limit blog post size in the list view.\\n\\n\x3c!--truncate--\x3e\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"},{"id":"first-blog-post","metadata":{"permalink":"/blog/first-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md","source":"@site/blog/2019-05-28-first-blog-post.md","title":"First Blog Post","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet","date":"2019-05-28T00:00:00.000Z","tags":[{"inline":false,"label":"Hola","permalink":"/blog/tags/hola","description":"Hola tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.12,"hasTruncateMarker":false,"authors":[{"name":"Gao Wei","title":"Docusaurus Core Team","url":"https://github.com/wgao19","image_url":"https://github.com/wgao19.png","imageURL":"https://github.com/wgao19.png","key":null,"page":null}],"frontMatter":{"slug":"first-blog-post","title":"First Blog Post","authors":{"name":"Gao Wei","title":"Docusaurus Core Team","url":"https://github.com/wgao19","image_url":"https://github.com/wgao19.png","imageURL":"https://github.com/wgao19.png"},"tags":["hola","docusaurus"]},"unlisted":false,"prevItem":{"title":"Long Blog Post","permalink":"/blog/long-blog-post"}},"content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}]}}')}}]); \ No newline at end of file diff --git a/assets/js/f81c1134.a0a97839.js b/assets/js/f81c1134.a0a97839.js deleted file mode 100644 index e17197c7d1..0000000000 --- a/assets/js/f81c1134.a0a97839.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8130],{7735:e=>{e.exports=JSON.parse('{"archive":{"blogPosts":[{"id":"welcome","metadata":{"permalink":"/blog/welcome","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-26-welcome/index.md","source":"@site/blog/2021-08-26-welcome/index.md","title":"Welcome","description":"Docusaurus blogging features are powered by the blog plugin.","date":"2021-08-26T00:00:00.000Z","tags":[{"inline":false,"label":"Facebook","permalink":"/blog/tags/facebook","description":"Facebook tag description"},{"inline":false,"label":"Hello","permalink":"/blog/tags/hello","description":"Hello tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.405,"hasTruncateMarker":false,"authors":[{"name":"S\xe9bastien Lorber","title":"Docusaurus maintainer","url":"https://sebastienlorber.com","imageURL":"https://github.com/slorber.png","key":"slorber"},{"name":"Yangshun Tay","title":"Front End Engineer @ Facebook","url":"https://github.com/yangshun","imageURL":"https://github.com/yangshun.png","key":"yangshun"}],"frontMatter":{"slug":"welcome","title":"Welcome","authors":["slorber","yangshun"],"tags":["facebook","hello","docusaurus"]},"unlisted":false,"nextItem":{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post"}},"content":"[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).\\n\\nSimply add Markdown files (or folders) to the `blog` directory.\\n\\nRegular blog authors can be added to `authors.yml`.\\n\\nThe blog post date can be extracted from filenames, such as:\\n\\n- `2019-05-30-welcome.md`\\n- `2019-05-30-welcome/index.md`\\n\\nA blog post folder can be convenient to co-locate blog post images:\\n\\n![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)\\n\\nThe blog supports tags as well!\\n\\n**And if you don\'t want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config."},{"id":"mdx-blog-post","metadata":{"permalink":"/blog/mdx-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2021-08-01-mdx-blog-post.mdx","source":"@site/blog/2021-08-01-mdx-blog-post.mdx","title":"MDX Blog Post","description":"Blog posts support Docusaurus Markdown features, such as MDX.","date":"2021-08-01T00:00:00.000Z","tags":[{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.175,"hasTruncateMarker":false,"authors":[{"name":"S\xe9bastien Lorber","title":"Docusaurus maintainer","url":"https://sebastienlorber.com","imageURL":"https://github.com/slorber.png","key":"slorber"}],"frontMatter":{"slug":"mdx-blog-post","title":"MDX Blog Post","authors":["slorber"],"tags":["docusaurus"]},"unlisted":false,"prevItem":{"title":"Welcome","permalink":"/blog/welcome"},"nextItem":{"title":"Long Blog Post","permalink":"/blog/long-blog-post"}},"content":"Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).\\n\\n:::tip\\n\\nUse the power of React to create interactive blog posts.\\n\\n```js\\n\\n```\\n\\n\\n\\n:::"},{"id":"long-blog-post","metadata":{"permalink":"/blog/long-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-29-long-blog-post.md","source":"@site/blog/2019-05-29-long-blog-post.md","title":"Long Blog Post","description":"This is the summary of a very long blog post,","date":"2019-05-29T00:00:00.000Z","tags":[{"inline":false,"label":"Hello","permalink":"/blog/tags/hello","description":"Hello tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":2.05,"hasTruncateMarker":true,"authors":[{"name":"Endilie Yacop Sucipto","title":"Maintainer of Docusaurus","url":"https://github.com/endiliey","imageURL":"https://github.com/endiliey.png","key":"endi"}],"frontMatter":{"slug":"long-blog-post","title":"Long Blog Post","authors":"endi","tags":["hello","docusaurus"]},"unlisted":false,"prevItem":{"title":"MDX Blog Post","permalink":"/blog/mdx-blog-post"},"nextItem":{"title":"First Blog Post","permalink":"/blog/first-blog-post"}},"content":"This is the summary of a very long blog post,\\n\\nUse a `\x3c!--` `truncate` `--\x3e` comment to limit blog post size in the list view.\\n\\n\x3c!--truncate--\x3e\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"},{"id":"first-blog-post","metadata":{"permalink":"/blog/first-blog-post","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2019-05-28-first-blog-post.md","source":"@site/blog/2019-05-28-first-blog-post.md","title":"First Blog Post","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet","date":"2019-05-28T00:00:00.000Z","tags":[{"inline":false,"label":"Hola","permalink":"/blog/tags/hola","description":"Hola tag description"},{"inline":false,"label":"Docusaurus","permalink":"/blog/tags/docusaurus","description":"Docusaurus tag description"}],"readingTime":0.12,"hasTruncateMarker":false,"authors":[{"name":"Gao Wei","title":"Docusaurus Core Team","url":"https://github.com/wgao19","image_url":"https://github.com/wgao19.png","imageURL":"https://github.com/wgao19.png"}],"frontMatter":{"slug":"first-blog-post","title":"First Blog Post","authors":{"name":"Gao Wei","title":"Docusaurus Core Team","url":"https://github.com/wgao19","image_url":"https://github.com/wgao19.png","imageURL":"https://github.com/wgao19.png"},"tags":["hola","docusaurus"]},"unlisted":false,"prevItem":{"title":"Long Blog Post","permalink":"/blog/long-blog-post"}},"content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet"}]}}')}}]); \ No newline at end of file diff --git a/assets/js/fb1af417.385f2e7a.js b/assets/js/fb1af417.385f2e7a.js new file mode 100644 index 0000000000..703d72c496 --- /dev/null +++ b/assets/js/fb1af417.385f2e7a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6463],{4431:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var o=n(4848),r=n(8453);const t={},c="Type Alias: EasyApiResponse",i={id:"reference/api/model/type-aliases/EasyApiResponse",title:"Type Alias: EasyApiResponse",description:"EasyApiResponse: object",source:"@site/docs/reference/api/model/type-aliases/EasyApiResponse.md",sourceDirName:"reference/api/model/type-aliases",slug:"/reference/api/model/type-aliases/EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/type-aliases/EasyApiResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo"},next:{title:"controllers/events",permalink:"/docs/reference/controllers/events/"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"response",id:"response",level:3},{value:"success",id:"success",level:3}];function p(e){const s={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"type-alias-easyapiresponse",children:"Type Alias: EasyApiResponse"})}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"EasyApiResponse"}),": ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,o.jsx)(s.h3,{id:"response",children:"response"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"response"}),": ",(0,o.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,o.jsx)(s.h3,{id:"success",children:"success"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"success"}),": ",(0,o.jsx)(s.code,{children:"boolean"})]}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>i});var o=n(6540);const r={},t=o.createContext(r);function c(e){const s=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb1af417.fb1945dc.js b/assets/js/fb1af417.fb1945dc.js deleted file mode 100644 index c6fdb43d89..0000000000 --- a/assets/js/fb1af417.fb1945dc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6463],{4431:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=n(4848),t=n(8453);const r={},c="Type Alias: EasyApiResponse",i={id:"reference/api/model/type-aliases/EasyApiResponse",title:"Type Alias: EasyApiResponse",description:"EasyApiResponse: object",source:"@site/docs/reference/api/model/type-aliases/EasyApiResponse.md",sourceDirName:"reference/api/model/type-aliases",slug:"/reference/api/model/type-aliases/EasyApiResponse",permalink:"/docs/reference/api/model/type-aliases/EasyApiResponse",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/type-aliases/EasyApiResponse.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: SessionInfo",permalink:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo"},next:{title:"controllers/events",permalink:"/docs/reference/controllers/events/"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"response",id:"response",level:3},{value:"success",id:"success",level:3}];function p(e){const s={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"type-alias-easyapiresponse",children:"Type Alias: EasyApiResponse"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"EasyApiResponse"}),": ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,o.jsx)(s.h3,{id:"response",children:"response"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"response"}),": ",(0,o.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,o.jsx)(s.h3,{id:"success",children:"success"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"success"}),": ",(0,o.jsx)(s.code,{children:"boolean"})]}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>i});var o=n(6540);const t={},r=o.createContext(t);function c(e){const s=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),o.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb5cf5eb.1d5b5af0.js b/assets/js/fb5cf5eb.1d5b5af0.js deleted file mode 100644 index e8080b16c0..0000000000 --- a/assets/js/fb5cf5eb.1d5b5af0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7569],{2344:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var n=s(4848),c=s(8453);const i={},t="Class: CustomError",d={id:"reference/api/model/errors/classes/CustomError",title:"Class: CustomError",description:"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum",source:"@site/docs/reference/api/model/errors/classes/CustomError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/CustomError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError"},next:{title:"Class: PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new CustomError()",id:"new-customerror",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"class-customerror",children:"Class: CustomError"}),"\n",(0,n.jsx)(r.p,{children:"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum"}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-customerror",children:"new CustomError()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new CustomError"}),"(",(0,n.jsx)(r.code,{children:"name"}),", ",(0,n.jsx)(r.code,{children:"message"}),"?, ...",(0,n.jsx)(r.code,{children:"params"}),"?): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:(0,n.jsx)(r.code,{children:"CustomError"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:(0,n.jsx)(r.code,{children:"ERROR_NAME"})})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"message?"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ...",(0,n.jsx)(r.strong,{children:"params?"}),": ",(0,n.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:(0,n.jsx)(r.code,{children:"CustomError"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>t,x:()=>d});var n=s(6540);const c={},i=n.createContext(c);function t(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb5cf5eb.f8677f77.js b/assets/js/fb5cf5eb.f8677f77.js new file mode 100644 index 0000000000..5fe601fd55 --- /dev/null +++ b/assets/js/fb5cf5eb.f8677f77.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7569],{2344:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>t,toc:()=>o});var n=s(4848),c=s(8453);const i={},d="Class: CustomError",t={id:"reference/api/model/errors/classes/CustomError",title:"Class: CustomError",description:"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum",source:"@site/docs/reference/api/model/errors/classes/CustomError.md",sourceDirName:"reference/api/model/errors/classes",slug:"/reference/api/model/errors/classes/CustomError",permalink:"/docs/reference/api/model/errors/classes/CustomError",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/classes/CustomError.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: AddParticipantError",permalink:"/docs/reference/api/model/errors/classes/AddParticipantError"},next:{title:"Class: PageEvaluationTimeout",permalink:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout"}},l={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new CustomError()",id:"new-customerror",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"prepareStackTrace()?",id:"preparestacktrace",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace()",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4}];function a(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"class-customerror",children:"Class: CustomError"})}),"\n",(0,n.jsx)(r.p,{children:"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum"}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.code,{children:"Error"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"new-customerror",children:"new CustomError()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new CustomError"}),"(",(0,n.jsx)(r.code,{children:"name"}),", ",(0,n.jsx)(r.code,{children:"message"}),"?, ...",(0,n.jsx)(r.code,{children:"params"}),"?): ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:(0,n.jsx)(r.code,{children:"CustomError"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:(0,n.jsx)(r.code,{children:"ERROR_NAME"})})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"message?"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ...",(0,n.jsx)(r.strong,{children:"params?"}),": ",(0,n.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:(0,n.jsx)(r.code,{children:"CustomError"})})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.constructor"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"cause",children:"cause?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"cause"}),": ",(0,n.jsx)(r.code,{children:"unknown"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.cause"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"message"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.message"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.name"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stack",children:"stack?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"stack"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stack"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace()?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,n.jsx)(r.code,{children:"err"}),", ",(0,n.jsx)(r.code,{children:"stackTraces"}),") => ",(0,n.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"err"}),": ",(0,n.jsx)(r.code,{children:"Error"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"stackTraces"}),": ",(0,n.jsx)(r.code,{children:"CallSite"}),"[]"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"any"})}),"\n",(0,n.jsx)(r.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.prepareStackTrace"})}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,n.jsx)(r.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.stackTraceLimit"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"static"})," ",(0,n.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,n.jsx)(r.code,{children:"targetObject"}),", ",(0,n.jsx)(r.code,{children:"constructorOpt"}),"?): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"targetObject"}),": ",(0,n.jsx)(r.code,{children:"object"})]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"constructorOpt?"}),": ",(0,n.jsx)(r.code,{children:"Function"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Error.captureStackTrace"})})]})}function h(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>d,x:()=>t});var n=s(6540);const c={},i=n.createContext(c);function d(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbf304ed.3957c062.js b/assets/js/fbf304ed.3957c062.js deleted file mode 100644 index 12046bfa83..0000000000 --- a/assets/js/fbf304ed.3957c062.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4453],{1339:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=t(4848),o=t(8453);const a={},i="Enumeration: ChatMuteDuration",s={id:"reference/api/model/chat/enumerations/ChatMuteDuration",title:"Enumeration: ChatMuteDuration",description:"Valid durations for muting a chat using [[muteChat]]",source:"@site/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/chat",permalink:"/docs/reference/api/model/chat/"},next:{title:"Enumeration: ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState"}},c={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"EIGHT_HOURS",id:"eight_hours",level:3},{value:"FOREVER",id:"forever",level:3},{value:"ONE_WEEK",id:"one_week",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-chatmuteduration",children:"Enumeration: ChatMuteDuration"}),"\n",(0,r.jsx)(n.p,{children:"Valid durations for muting a chat using [[muteChat]]"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"eight_hours",children:"EIGHT_HOURS"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EIGHT_HOURS"}),": ",(0,r.jsx)(n.code,{children:'"EIGHT_HOURS"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat for 8 hours"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"forever",children:"FOREVER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"FOREVER"}),": ",(0,r.jsx)(n.code,{children:'"FOREVER"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat forever"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"one_week",children:"ONE_WEEK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ONE_WEEK"}),": ",(0,r.jsx)(n.code,{children:'"ONE_WEEK"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat for 1 week"})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>s});var r=t(6540);const o={},a=r.createContext(o);function i(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbf304ed.f6e788fb.js b/assets/js/fbf304ed.f6e788fb.js new file mode 100644 index 0000000000..d5a1c520fe --- /dev/null +++ b/assets/js/fbf304ed.f6e788fb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4453],{1339:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=t(4848),o=t(8453);const a={},i="Enumeration: ChatMuteDuration",s={id:"reference/api/model/chat/enumerations/ChatMuteDuration",title:"Enumeration: ChatMuteDuration",description:"Valid durations for muting a chat using [[muteChat]]",source:"@site/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",sourceDirName:"reference/api/model/chat/enumerations",slug:"/reference/api/model/chat/enumerations/ChatMuteDuration",permalink:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/model/chat",permalink:"/docs/reference/api/model/chat/"},next:{title:"Enumeration: ChatState",permalink:"/docs/reference/api/model/chat/enumerations/ChatState"}},c={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"EIGHT_HOURS",id:"eight_hours",level:3},{value:"FOREVER",id:"forever",level:3},{value:"ONE_WEEK",id:"one_week",level:3}];function d(e){const n={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"enumeration-chatmuteduration",children:"Enumeration: ChatMuteDuration"})}),"\n",(0,r.jsx)(n.p,{children:"Valid durations for muting a chat using [[muteChat]]"}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"eight_hours",children:"EIGHT_HOURS"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EIGHT_HOURS"}),": ",(0,r.jsx)(n.code,{children:'"EIGHT_HOURS"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat for 8 hours"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"forever",children:"FOREVER"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"FOREVER"}),": ",(0,r.jsx)(n.code,{children:'"FOREVER"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat forever"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"one_week",children:"ONE_WEEK"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ONE_WEEK"}),": ",(0,r.jsx)(n.code,{children:'"ONE_WEEK"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Mutes chat for 1 week"})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>s});var r=t(6540);const o={},a=r.createContext(o);function i(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc7d6c3b.0e13b098.js b/assets/js/fc7d6c3b.0e13b098.js deleted file mode 100644 index 94c54fcae0..0000000000 --- a/assets/js/fc7d6c3b.0e13b098.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8629],{855:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var i=r(4848),s=r(8453);const t={},l="Class: LogToEvTransport",d={id:"reference/logging/custom_transport/classes/LogToEvTransport",title:"Class: LogToEvTransport",description:"Extends",source:"@site/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",sourceDirName:"reference/logging/custom_transport/classes",slug:"/reference/logging/custom_transport/classes/LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"logging/custom\\_transport",permalink:"/docs/reference/logging/custom_transport/"},next:{title:"Class: NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport"}},c={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new LogToEvTransport()",id:"new-logtoevtransport",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"closed",id:"closed",level:3},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"destroyed",id:"destroyed",level:3},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"errored",id:"errored",level:3},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"format?",id:"format",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"handleExceptions?",id:"handleexceptions",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"handleRejections?",id:"handlerejections",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"level?",id:"level",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"silent?",id:"silent",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"writable",id:"writable",level:3},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"writableCorked",id:"writablecorked",level:3},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"writableEnded",id:"writableended",level:3},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"writableFinished",id:"writablefinished",level:3},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"writableHighWaterMark",id:"writablehighwatermark",level:3},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"writableLength",id:"writablelength",level:3},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"writableNeedDrain",id:"writableneeddrain",level:3},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"writableObjectMode",id:"writableobjectmode",level:3},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Methods",id:"methods",level:2},{value:"_construct()?",id:"_construct",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"_destroy()",id:"_destroy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"_final()",id:"_final",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"_write()",id:"_write",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"_writev()?",id:"_writev",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"addListener(event, listener)",id:"addlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Since",id:"since-11",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-8",level:5},{value:"Since",id:"since-12",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Since",id:"since-13",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Since",id:"since-14",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Since",id:"since-15",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Since",id:"since-16",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"close()?",id:"close",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"cork()",id:"cork",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-18",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"emit()",id:"emit",level:3},{value:"emit(event)",id:"emitevent",level:4},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Since",id:"since-19",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"emit(event)",id:"emitevent-1",level:4},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Since",id:"since-20",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"emit(event, err)",id:"emitevent-err",level:4},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Since",id:"since-21",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"emit(event)",id:"emitevent-2",level:4},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Since",id:"since-22",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"emit(event, src)",id:"emitevent-src",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Since",id:"since-23",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"emit(event, src)",id:"emitevent-src-1",level:4},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Since",id:"since-24",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"emit(event, args)",id:"emitevent-args",level:4},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Since",id:"since-25",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"end()",id:"end",level:3},{value:"end(cb)",id:"endcb",level:4},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Since",id:"since-26",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"end(chunk, cb)",id:"endchunk-cb",level:4},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"end(chunk, encoding, cb)",id:"endchunk-encoding-cb",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-44",level:5},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-27",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-28",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Since",id:"since-29",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Since",id:"since-30",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"logv()?",id:"logv",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Since",id:"since-31",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"on()",id:"on",level:3},{value:"on(event, listener)",id:"onevent-listener",level:4},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Since",id:"since-32",level:5},{value:"Inherited from",id:"inherited-from-51",level:5},{value:"on(event, listener)",id:"onevent-listener-1",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-34",level:5},{value:"Since",id:"since-33",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"on(event, listener)",id:"onevent-listener-2",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Since",id:"since-34",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"on(event, listener)",id:"onevent-listener-3",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-36",level:5},{value:"Since",id:"since-35",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"on(event, listener)",id:"onevent-listener-4",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-36",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"on(event, listener)",id:"onevent-listener-5",level:4},{value:"Parameters",id:"parameters-34",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-37",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"on(event, listener)",id:"onevent-listener-6",level:4},{value:"Parameters",id:"parameters-35",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Since",id:"since-38",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"once()",id:"once",level:3},{value:"once(event, listener)",id:"onceevent-listener",level:4},{value:"Parameters",id:"parameters-36",level:5},{value:"Returns",id:"returns-40",level:5},{value:"Since",id:"since-39",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"once(event, listener)",id:"onceevent-listener-1",level:4},{value:"Parameters",id:"parameters-37",level:5},{value:"Returns",id:"returns-41",level:5},{value:"Since",id:"since-40",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"once(event, listener)",id:"onceevent-listener-2",level:4},{value:"Parameters",id:"parameters-38",level:5},{value:"Returns",id:"returns-42",level:5},{value:"Since",id:"since-41",level:5},{value:"Inherited from",id:"inherited-from-60",level:5},{value:"once(event, listener)",id:"onceevent-listener-3",level:4},{value:"Parameters",id:"parameters-39",level:5},{value:"Returns",id:"returns-43",level:5},{value:"Since",id:"since-42",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"once(event, listener)",id:"onceevent-listener-4",level:4},{value:"Parameters",id:"parameters-40",level:5},{value:"Returns",id:"returns-44",level:5},{value:"Since",id:"since-43",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"once(event, listener)",id:"onceevent-listener-5",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-45",level:5},{value:"Since",id:"since-44",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"once(event, listener)",id:"onceevent-listener-6",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-46",level:5},{value:"Since",id:"since-45",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"pipe()",id:"pipe",level:3},{value:"Type Parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-65",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-48",level:5},{value:"Since",id:"since-46",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Since",id:"since-47",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-50",level:5},{value:"Since",id:"since-48",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-47",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Since",id:"since-49",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Since",id:"since-50",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Since",id:"since-51",level:5},{value:"Inherited from",id:"inherited-from-71",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Since",id:"since-52",level:5},{value:"Inherited from",id:"inherited-from-72",level:5},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Since",id:"since-53",level:5},{value:"Inherited from",id:"inherited-from-73",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-56",level:5},{value:"Since",id:"since-54",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Since",id:"since-55",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Since",id:"since-56",level:5},{value:"Inherited from",id:"inherited-from-76",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Since",id:"since-57",level:5},{value:"Inherited from",id:"inherited-from-77",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-56",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Since",id:"since-58",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-57",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Since",id:"since-59",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Since",id:"since-60",level:4},{value:"Inherited from",id:"inherited-from-80",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Since",id:"since-61",level:4},{value:"Inherited from",id:"inherited-from-81",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"removeListener(event, listener)",id:"removelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-60",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Since",id:"since-62",level:5},{value:"Inherited from",id:"inherited-from-82",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-61",level:5},{value:"Returns",id:"returns-65",level:5},{value:"Since",id:"since-63",level:5},{value:"Inherited from",id:"inherited-from-83",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Since",id:"since-64",level:5},{value:"Inherited from",id:"inherited-from-84",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-67",level:5},{value:"Since",id:"since-65",level:5},{value:"Inherited from",id:"inherited-from-85",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-68",level:5},{value:"Since",id:"since-66",level:5},{value:"Inherited from",id:"inherited-from-86",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-69",level:5},{value:"Since",id:"since-67",level:5},{value:"Inherited from",id:"inherited-from-87",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-66",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Since",id:"since-68",level:5},{value:"Inherited from",id:"inherited-from-88",level:5},{value:"setDefaultEncoding()",id:"setdefaultencoding",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Since",id:"since-69",level:4},{value:"Inherited from",id:"inherited-from-89",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Since",id:"since-70",level:4},{value:"Inherited from",id:"inherited-from-90",level:4},{value:"uncork()",id:"uncork",level:3},{value:"Returns",id:"returns-73",level:4},{value:"Since",id:"since-71",level:4},{value:"Inherited from",id:"inherited-from-91",level:4},{value:"write()",id:"write",level:3},{value:"write(chunk, callback)",id:"writechunk-callback",level:4},{value:"Parameters",id:"parameters-69",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Since",id:"since-72",level:5},{value:"Inherited from",id:"inherited-from-92",level:5},{value:"write(chunk, encoding, callback)",id:"writechunk-encoding-callback",level:4},{value:"Parameters",id:"parameters-70",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-93",level:5},{value:"fromWeb()",id:"fromweb",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-76",level:4},{value:"Since",id:"since-73",level:4},{value:"Inherited from",id:"inherited-from-94",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-77",level:4},{value:"Since",id:"since-74",level:4},{value:"Inherited from",id:"inherited-from-95",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-78",level:4},{value:"Since",id:"since-75",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-96",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-79",level:4},{value:"Since",id:"since-76",level:4},{value:"Inherited from",id:"inherited-from-97",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-75",level:5},{value:"Returns",id:"returns-80",level:5},{value:"Since",id:"since-77",level:5},{value:"Inherited from",id:"inherited-from-98",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-76",level:5},{value:"Returns",id:"returns-81",level:5},{value:"Inherited from",id:"inherited-from-99",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-82",level:4},{value:"Since",id:"since-78",level:4},{value:"Inherited from",id:"inherited-from-100",level:4},{value:"toWeb()",id:"toweb",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-83",level:4},{value:"Since",id:"since-79",level:4},{value:"Inherited from",id:"inherited-from-101",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"class-logtoevtransport",children:"Class: LogToEvTransport"}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"TransportStream"})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-logtoevtransport",children:"new LogToEvTransport()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new LogToEvTransport"}),"(",(0,i.jsx)(n.code,{children:"opts"}),"?): ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:(0,i.jsx)(n.code,{children:"LogToEvTransport"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"opts?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:(0,i.jsx)(n.code,{children:"LogToEvTransport"})})}),"\n",(0,i.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.constructor"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"closed",children:"closed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"closed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Is true after 'close' has been emitted."}),"\n",(0,i.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.closed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroyed",children:"destroyed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroyed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.destroy()"})," has been called."]}),"\n",(0,i.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroyed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errored",children:"errored"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"errored"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Returns error if the stream has been destroyed with an error."}),"\n",(0,i.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v18.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errored"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"format",children:"format?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"format"}),": ",(0,i.jsx)(n.code,{children:"Format"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.format"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handleexceptions",children:"handleExceptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleExceptions"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleExceptions"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handlerejections",children:"handleRejections?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"level",children:"level?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"level"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.level"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"silent"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.silent"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writable",children:"writable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if it is safe to call ",(0,i.jsx)(n.code,{children:"writable.write()"}),", which means\nthe stream has not been destroyed, errored or ended."]}),"\n",(0,i.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writable"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablecorked",children:"writableCorked"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableCorked"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Number of times ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," needs to be\ncalled in order to fully uncork the stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.2.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableCorked"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableended",children:"writableEnded"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableEnded"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.end()"})," has been called. This property\ndoes not indicate whether the data has been flushed, for this use ",(0,i.jsx)(n.code,{children:"writable.writableFinished"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.9.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableEnded"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablefinished",children:"writableFinished"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableFinished"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is set to ",(0,i.jsx)(n.code,{children:"true"})," immediately before the ",(0,i.jsx)(n.code,{children:"'finish'"})," event is emitted."]}),"\n",(0,i.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.6.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableFinished"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablehighwatermark",children:"writableHighWaterMark"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableHighWaterMark"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Return the value of ",(0,i.jsx)(n.code,{children:"highWaterMark"})," passed when creating this ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableHighWaterMark"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablelength",children:"writableLength"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This property contains the number of bytes (or objects) in the queue\nready to be written. The value provides introspection data regarding\nthe status of the ",(0,i.jsx)(n.code,{children:"highWaterMark"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableLength"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableneeddrain",children:"writableNeedDrain"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableNeedDrain"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if the stream's buffer has been full and stream will emit 'drain'."]}),"\n",(0,i.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableNeedDrain"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableobjectmode",children:"writableObjectMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableObjectMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Getter for the property ",(0,i.jsx)(n.code,{children:"objectMode"})," of a given ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableObjectMode"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,i.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejectionSymbol"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.defaultMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,i.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,i.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,i.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,i.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,i.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,i.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errorMonitor"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"_construct",children:"_construct()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_construct"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._construct"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_destroy",children:"_destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_final",children:"_final()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_final"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._final"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_write",children:"_write()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_writev",children:"_writev()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_writev"}),"(",(0,i.jsx)(n.code,{children:"chunks"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunks"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._writev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Event emitter\nThe defined events on documents including:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"close"}),"\n",(0,i.jsx)(n.li,{children:"drain"}),"\n",(0,i.jsx)(n.li,{children:"error"}),"\n",(0,i.jsx)(n.li,{children:"finish"}),"\n",(0,i.jsx)(n.li,{children:"pipe"}),"\n",(0,i.jsx)(n.li,{children:"unpipe"}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-1",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-11",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-2",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-12",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-3",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-13",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-4",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-14",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-5",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-15",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-6",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-12",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-16",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"close",children:"close()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"close"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.close"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cork",children:"cork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method forces all written data to be buffered in memory.\nThe buffered data will be flushed when either the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#uncork",children:"uncork"})," or ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#end",children:"end"})," methods are called."]}),"\n",(0,i.jsxs)(n.p,{children:["The primary intent of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," is to accommodate a situation in which\nseveral small chunks are written to the stream in rapid succession. Instead of\nimmediately forwarding them to the underlying destination, ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"buffers all the chunks until ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," is called, which will pass them\nall to ",(0,i.jsx)(n.code,{children:"writable._writev()"}),", if present. This prevents a head-of-line blocking\nsituation where data is being buffered while waiting for the first small chunk\nto be processed. However, use of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," without implementing",(0,i.jsx)(n.code,{children:"writable._writev()"})," may have an adverse effect on throughput."]}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.uncork()"}),", ",(0,i.jsx)(n.code,{children:"writable._writev()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.cork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Destroy the stream. Optionally emit an ",(0,i.jsx)(n.code,{children:"'error'"})," event, and emit a ",(0,i.jsx)(n.code,{children:"'close'"}),"event (unless ",(0,i.jsx)(n.code,{children:"emitClose"})," is set to ",(0,i.jsx)(n.code,{children:"false"}),"). After this call, the writable\nstream has ended and subsequent calls to ",(0,i.jsx)(n.code,{children:"write()"})," or ",(0,i.jsx)(n.code,{children:"end()"})," will result in\nan ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nThis is a destructive and immediate way to destroy a stream. Previous calls to",(0,i.jsx)(n.code,{children:"write()"})," may not have drained, and may trigger an ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nUse ",(0,i.jsx)(n.code,{children:"end()"})," instead of destroy if data should flush before close, or wait for\nthe ",(0,i.jsx)(n.code,{children:"'drain'"})," event before destroying the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["Once ",(0,i.jsx)(n.code,{children:"destroy()"})," has been called any further calls will be a no-op and no\nfurther errors except from ",(0,i.jsx)(n.code,{children:"_destroy()"})," may be emitted as ",(0,i.jsx)(n.code,{children:"'error'"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Implementors should not override this method,\nbut instead implement ",(0,i.jsx)(n.code,{children:"writable._destroy()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error?"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional, an error to emit with ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-18",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,i.jsx)(n.h4,{id:"emitevent",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-19",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-1",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-20",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-err",children:"emit(event, err)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"err"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"err"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-21",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-2",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-22",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-23",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src-1",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-24",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-args",children:"emit(event, args)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ...",(0,i.jsx)(n.code,{children:"args"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"args"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-25",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"end()"}),"\n",(0,i.jsx)(n.h4,{id:"endcb",children:"end(cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.code,{children:"writable.end()"})," method signals that no more data will be written\nto the ",(0,i.jsx)(n.code,{children:"Writable"}),". The optional ",(0,i.jsx)(n.code,{children:"chunk"})," and ",(0,i.jsx)(n.code,{children:"encoding"})," arguments allow one\nfinal additional chunk of data to be written immediately before closing the\nstream."]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#write",children:"write"})," method after calling ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#end",children:"end"})," will raise an error."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"// Write 'hello, ' and then end with 'world!'.\nconst fs = require('fs');\nconst file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// Writing more now is not allowed!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-26",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-cb",children:"end(chunk, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-encoding-cb",children:"end(chunk, encoding, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,i.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:["(",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-27",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.eventNames"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-28",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-29",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-30",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.log"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logv",children:"logv()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logv"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"next"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"next"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.logv"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"off"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-31",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.off"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-32",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-1",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-33",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-2",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-34",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-3",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-35",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-4",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-36",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-5",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-34",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-37",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-6",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-35",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-38",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-36",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-40",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-39",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-1",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-37",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-41",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-40",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-2",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-38",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-42",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-41",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-3",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-39",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-43",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-42",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-4",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-40",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-44",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-43",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-5",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-45",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-44",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-6",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-46",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-45",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pipe",children:"pipe()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pipe"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"destination"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"WritableStream"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"destination"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options.end?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.pipe"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-46",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-1",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-47",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-2",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-48",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-3",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-47",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-49",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-4",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-50",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-5",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-51",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-6",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-52",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-53",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-1",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-56",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-54",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-2",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-55",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-3",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-56",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-4",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-57",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-5",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-56",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-58",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-6",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-57",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-59",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"rawListeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,i.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-62",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-60",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.rawListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,i.jsx)(n.code,{children:"event"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event?"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-63",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-61",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeAllListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-60",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-62",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-1",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-61",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-63",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-2",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-64",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-84",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-3",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-67",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-65",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-85",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-4",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-68",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-66",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-86",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-5",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-69",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-67",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-87",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-6",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-66",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-68",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-88",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setdefaultencoding",children:"setDefaultEncoding()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setDefaultEncoding"}),"(",(0,i.jsx)(n.code,{children:"encoding"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.setDefaultEncoding()"})," method sets the default ",(0,i.jsx)(n.code,{children:"encoding"})," for a ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsx)(n.p,{children:"The new default encoding"}),"\n",(0,i.jsx)(n.h4,{id:"returns-71",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-69",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.15"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-89",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setDefaultEncoding"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["By default ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,i.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,i.jsx)(n.code,{children:"Infinity"})," (or ",(0,i.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-70",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-90",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"uncork",children:"uncork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"uncork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," method flushes all data buffered since ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#cork",children:"cork"})," was called."]}),"\n",(0,i.jsxs)(n.p,{children:["When using ",(0,i.jsx)(n.code,{children:"writable.cork()"})," and ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," to manage the buffering\nof writes to a stream, defer calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," using",(0,i.jsx)(n.code,{children:"process.nextTick()"}),". Doing so allows batching of all",(0,i.jsx)(n.code,{children:"writable.write()"})," calls that occur within a given Node.js event\nloop phase."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.write('data ');\nprocess.nextTick(() => stream.uncork());\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If the ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method is called multiple times on a stream, the\nsame number of calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," must be called to flush the buffered\ndata."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.cork();\nstream.write('data ');\nprocess.nextTick(() => {\n stream.uncork();\n // The data will not be flushed until uncork() is called a second time.\n stream.uncork();\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-71",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-91",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.uncork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"write",children:"write()"}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-callback",children:"write(chunk, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.write()"})," method writes some data to the stream, and calls the\nsupplied ",(0,i.jsx)(n.code,{children:"callback"})," once the data has been fully handled. If an error\noccurs, the ",(0,i.jsx)(n.code,{children:"callback"})," will be called with the error as its\nfirst argument. The ",(0,i.jsx)(n.code,{children:"callback"})," is called asynchronously and before ",(0,i.jsx)(n.code,{children:"'error'"})," is\nemitted."]}),"\n",(0,i.jsxs)(n.p,{children:["The return value is ",(0,i.jsx)(n.code,{children:"true"})," if the internal buffer is less than the",(0,i.jsx)(n.code,{children:"highWaterMark"})," configured when the stream was created after admitting ",(0,i.jsx)(n.code,{children:"chunk"}),".\nIf ",(0,i.jsx)(n.code,{children:"false"})," is returned, further attempts to write data to the stream should\nstop until the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted."]}),"\n",(0,i.jsxs)(n.p,{children:["While a stream is not draining, calls to ",(0,i.jsx)(n.code,{children:"write()"})," will buffer ",(0,i.jsx)(n.code,{children:"chunk"}),", and\nreturn false. Once all currently buffered chunks are drained (accepted for\ndelivery by the operating system), the ",(0,i.jsx)(n.code,{children:"'drain'"})," event will be emitted.\nOnce ",(0,i.jsx)(n.code,{children:"write()"})," returns false, do not write more chunks\nuntil the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted. While calling ",(0,i.jsx)(n.code,{children:"write()"})," on a stream that\nis not draining is allowed, Node.js will buffer all written chunks until\nmaximum memory usage occurs, at which point it will abort unconditionally.\nEven before it aborts, high memory usage will cause poor garbage collector\nperformance and high RSS (which is not typically released back to the system,\neven after the memory is no longer required). Since TCP sockets may never\ndrain if the remote peer does not read the data, writing a socket that is\nnot draining may lead to a remotely exploitable vulnerability."]}),"\n",(0,i.jsxs)(n.p,{children:["Writing data while the stream is not draining is particularly\nproblematic for a ",(0,i.jsx)(n.code,{children:"Transform"}),", because the ",(0,i.jsx)(n.code,{children:"Transform"})," streams are paused\nby default until they are piped or a ",(0,i.jsx)(n.code,{children:"'data'"})," or ",(0,i.jsx)(n.code,{children:"'readable'"})," event handler\nis added."]}),"\n",(0,i.jsxs)(n.p,{children:["If the data to be written can be generated or fetched on demand, it is\nrecommended to encapsulate the logic into a ",(0,i.jsx)(n.code,{children:"Readable"})," and use ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#pipe",children:"pipe"}),". However, if calling ",(0,i.jsx)(n.code,{children:"write()"})," is preferred, it is\npossible to respect backpressure and avoid memory issues using the ",(0,i.jsx)(n.code,{children:"'drain'"})," event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"function write(data, cb) {\n if (!stream.write(data)) {\n stream.once('drain', cb);\n } else {\n process.nextTick(cb);\n }\n}\n\n// Wait for cb to be called before doing any other write.\nwrite('hello', () => {\n console.log('Write completed, do more writes now.');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"Writable"})," stream in object mode will always ignore the ",(0,i.jsx)(n.code,{children:"encoding"})," argument."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-69",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional data to write. For streams not operating in object mode, ",(0,i.jsx)(n.code,{children:"chunk"})," must be a string, ",(0,i.jsx)(n.code,{children:"Buffer"})," or ",(0,i.jsx)(n.code,{children:"Uint8Array"}),". For object mode streams, ",(0,i.jsx)(n.code,{children:"chunk"})," may be any\nJavaScript value other than ",(0,i.jsx)(n.code,{children:"null"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.p,{children:"Callback for when this chunk of data is flushed."}),"\n",(0,i.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"false"})," if the stream wishes for the calling code to wait for the ",(0,i.jsx)(n.code,{children:"'drain'"})," event to be emitted before continuing to write additional data; otherwise ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"since-72",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-92",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-encoding-callback",children:"write(chunk, encoding, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-70",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-93",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fromweb",children:"fromWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"fromWeb"}),"(",(0,i.jsx)(n.code,{children:"writableStream"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a ",(0,i.jsx)(n.code,{children:"Writable"})," from a web ",(0,i.jsx)(n.code,{children:"WritableStream"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"writableStream"}),": ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Pick"}),"<",(0,i.jsx)(n.code,{children:"WritableOptions"}),", ",(0,i.jsx)(n.code,{children:'"signal"'})," | ",(0,i.jsx)(n.code,{children:'"decodeStrings"'})," | ",(0,i.jsx)(n.code,{children:'"highWaterMark"'})," | ",(0,i.jsx)(n.code,{children:'"objectMode"'}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-76",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Writable"})}),"\n",(0,i.jsx)(n.h4,{id:"since-73",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-94",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.fromWeb"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"name"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,i.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-77",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-74",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-95",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getEventListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount-1",children:(0,i.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,i.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,i.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The event name"}),"\n",(0,i.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-75",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,i.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-96",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns an ",(0,i.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,i.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,i.jsx)(n.code,{children:"emitter"})]}),"\n",(0,i.jsx)(n.h4,{id:"since-76",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-97",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Creates a ",(0,i.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,i.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,i.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,i.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,i.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The special handling of the ",(0,i.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,i.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,i.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,i.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-75",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-80",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"since-77",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-98",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-76",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-81",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-99",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"?, ...",(0,i.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n?"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,i.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-82",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-78",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-100",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"toweb",children:"toWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"toWeb"}),"(",(0,i.jsx)(n.code,{children:"streamWritable"}),"): ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a web ",(0,i.jsx)(n.code,{children:"WritableStream"})," from a ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"streamWritable"}),": ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-83",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"since-79",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-101",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.toWeb"})})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>d});var i=r(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc7d6c3b.be712c6c.js b/assets/js/fc7d6c3b.be712c6c.js new file mode 100644 index 0000000000..8dcef88e90 --- /dev/null +++ b/assets/js/fc7d6c3b.be712c6c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8629],{855:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var i=r(4848),s=r(8453);const t={},l="Class: LogToEvTransport",d={id:"reference/logging/custom_transport/classes/LogToEvTransport",title:"Class: LogToEvTransport",description:"Extends",source:"@site/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",sourceDirName:"reference/logging/custom_transport/classes",slug:"/reference/logging/custom_transport/classes/LogToEvTransport",permalink:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"logging/custom\\_transport",permalink:"/docs/reference/logging/custom_transport/"},next:{title:"Class: NoOpTransport",permalink:"/docs/reference/logging/custom_transport/classes/NoOpTransport"}},c={},o=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new LogToEvTransport()",id:"new-logtoevtransport",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"closed",id:"closed",level:3},{value:"Since",id:"since",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"destroyed",id:"destroyed",level:3},{value:"Since",id:"since-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"errored",id:"errored",level:3},{value:"Since",id:"since-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"format?",id:"format",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"handleExceptions?",id:"handleexceptions",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"handleRejections?",id:"handlerejections",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"level?",id:"level",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"silent?",id:"silent",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"writable",id:"writable",level:3},{value:"Since",id:"since-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"writableCorked",id:"writablecorked",level:3},{value:"Since",id:"since-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"writableEnded",id:"writableended",level:3},{value:"Since",id:"since-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"writableFinished",id:"writablefinished",level:3},{value:"Since",id:"since-6",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"writableHighWaterMark",id:"writablehighwatermark",level:3},{value:"Since",id:"since-7",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"writableLength",id:"writablelength",level:3},{value:"Since",id:"since-8",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"writableNeedDrain",id:"writableneeddrain",level:3},{value:"Since",id:"since-9",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"writableObjectMode",id:"writableobjectmode",level:3},{value:"Since",id:"since-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Methods",id:"methods",level:2},{value:"_construct()?",id:"_construct",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"_destroy()",id:"_destroy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"_final()",id:"_final",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"_write()",id:"_write",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"_writev()?",id:"_writev",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"addListener()",id:"addlistener",level:3},{value:"addListener(event, listener)",id:"addlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Since",id:"since-11",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-8",level:5},{value:"Since",id:"since-12",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Since",id:"since-13",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Since",id:"since-14",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Since",id:"since-15",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"addListener(event, listener)",id:"addlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Since",id:"since-16",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"close()?",id:"close",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"cork()",id:"cork",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Since",id:"since-17",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"destroy()",id:"destroy",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Since",id:"since-18",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"emit()",id:"emit",level:3},{value:"emit(event)",id:"emitevent",level:4},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Since",id:"since-19",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"emit(event)",id:"emitevent-1",level:4},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Since",id:"since-20",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"emit(event, err)",id:"emitevent-err",level:4},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Since",id:"since-21",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"emit(event)",id:"emitevent-2",level:4},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Since",id:"since-22",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"emit(event, src)",id:"emitevent-src",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Since",id:"since-23",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"emit(event, src)",id:"emitevent-src-1",level:4},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Since",id:"since-24",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"emit(event, args)",id:"emitevent-args",level:4},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Since",id:"since-25",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"end()",id:"end",level:3},{value:"end(cb)",id:"endcb",level:4},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Since",id:"since-26",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"end(chunk, cb)",id:"endchunk-cb",level:4},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"end(chunk, encoding, cb)",id:"endchunk-encoding-cb",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-44",level:5},{value:"eventNames()",id:"eventnames",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Since",id:"since-27",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"getMaxListeners()",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Since",id:"since-28",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"listenerCount()",id:"listenercount",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Since",id:"since-29",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"listeners()",id:"listeners",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Since",id:"since-30",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"logv()?",id:"logv",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"off()",id:"off",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Since",id:"since-31",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"on()",id:"on",level:3},{value:"on(event, listener)",id:"onevent-listener",level:4},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Since",id:"since-32",level:5},{value:"Inherited from",id:"inherited-from-51",level:5},{value:"on(event, listener)",id:"onevent-listener-1",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-34",level:5},{value:"Since",id:"since-33",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"on(event, listener)",id:"onevent-listener-2",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Since",id:"since-34",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"on(event, listener)",id:"onevent-listener-3",level:4},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-36",level:5},{value:"Since",id:"since-35",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"on(event, listener)",id:"onevent-listener-4",level:4},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Since",id:"since-36",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"on(event, listener)",id:"onevent-listener-5",level:4},{value:"Parameters",id:"parameters-34",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Since",id:"since-37",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"on(event, listener)",id:"onevent-listener-6",level:4},{value:"Parameters",id:"parameters-35",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Since",id:"since-38",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"once()",id:"once",level:3},{value:"once(event, listener)",id:"onceevent-listener",level:4},{value:"Parameters",id:"parameters-36",level:5},{value:"Returns",id:"returns-40",level:5},{value:"Since",id:"since-39",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"once(event, listener)",id:"onceevent-listener-1",level:4},{value:"Parameters",id:"parameters-37",level:5},{value:"Returns",id:"returns-41",level:5},{value:"Since",id:"since-40",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"once(event, listener)",id:"onceevent-listener-2",level:4},{value:"Parameters",id:"parameters-38",level:5},{value:"Returns",id:"returns-42",level:5},{value:"Since",id:"since-41",level:5},{value:"Inherited from",id:"inherited-from-60",level:5},{value:"once(event, listener)",id:"onceevent-listener-3",level:4},{value:"Parameters",id:"parameters-39",level:5},{value:"Returns",id:"returns-43",level:5},{value:"Since",id:"since-42",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"once(event, listener)",id:"onceevent-listener-4",level:4},{value:"Parameters",id:"parameters-40",level:5},{value:"Returns",id:"returns-44",level:5},{value:"Since",id:"since-43",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"once(event, listener)",id:"onceevent-listener-5",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-45",level:5},{value:"Since",id:"since-44",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"once(event, listener)",id:"onceevent-listener-6",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-46",level:5},{value:"Since",id:"since-45",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"pipe()",id:"pipe",level:3},{value:"Type Parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-65",level:4},{value:"prependListener()",id:"prependlistener",level:3},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener",level:4},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-48",level:5},{value:"Since",id:"since-46",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Since",id:"since-47",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-50",level:5},{value:"Since",id:"since-48",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-47",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Since",id:"since-49",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Since",id:"since-50",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Since",id:"since-51",level:5},{value:"Inherited from",id:"inherited-from-71",level:5},{value:"prependListener(event, listener)",id:"prependlistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Since",id:"since-52",level:5},{value:"Inherited from",id:"inherited-from-72",level:5},{value:"prependOnceListener()",id:"prependoncelistener",level:3},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Since",id:"since-53",level:5},{value:"Inherited from",id:"inherited-from-73",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-56",level:5},{value:"Since",id:"since-54",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Since",id:"since-55",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Since",id:"since-56",level:5},{value:"Inherited from",id:"inherited-from-76",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Since",id:"since-57",level:5},{value:"Inherited from",id:"inherited-from-77",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-56",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Since",id:"since-58",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"prependOnceListener(event, listener)",id:"prependoncelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-57",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Since",id:"since-59",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"rawListeners()",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Since",id:"since-60",level:4},{value:"Inherited from",id:"inherited-from-80",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Since",id:"since-61",level:4},{value:"Inherited from",id:"inherited-from-81",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"removeListener(event, listener)",id:"removelistenerevent-listener",level:4},{value:"Parameters",id:"parameters-60",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Since",id:"since-62",level:5},{value:"Inherited from",id:"inherited-from-82",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-1",level:4},{value:"Parameters",id:"parameters-61",level:5},{value:"Returns",id:"returns-65",level:5},{value:"Since",id:"since-63",level:5},{value:"Inherited from",id:"inherited-from-83",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-2",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Since",id:"since-64",level:5},{value:"Inherited from",id:"inherited-from-84",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-3",level:4},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-67",level:5},{value:"Since",id:"since-65",level:5},{value:"Inherited from",id:"inherited-from-85",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-4",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-68",level:5},{value:"Since",id:"since-66",level:5},{value:"Inherited from",id:"inherited-from-86",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-5",level:4},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-69",level:5},{value:"Since",id:"since-67",level:5},{value:"Inherited from",id:"inherited-from-87",level:5},{value:"removeListener(event, listener)",id:"removelistenerevent-listener-6",level:4},{value:"Parameters",id:"parameters-66",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Since",id:"since-68",level:5},{value:"Inherited from",id:"inherited-from-88",level:5},{value:"setDefaultEncoding()",id:"setdefaultencoding",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Since",id:"since-69",level:4},{value:"Inherited from",id:"inherited-from-89",level:4},{value:"setMaxListeners()",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Since",id:"since-70",level:4},{value:"Inherited from",id:"inherited-from-90",level:4},{value:"uncork()",id:"uncork",level:3},{value:"Returns",id:"returns-73",level:4},{value:"Since",id:"since-71",level:4},{value:"Inherited from",id:"inherited-from-91",level:4},{value:"write()",id:"write",level:3},{value:"write(chunk, callback)",id:"writechunk-callback",level:4},{value:"Parameters",id:"parameters-69",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Since",id:"since-72",level:5},{value:"Inherited from",id:"inherited-from-92",level:5},{value:"write(chunk, encoding, callback)",id:"writechunk-encoding-callback",level:4},{value:"Parameters",id:"parameters-70",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-93",level:5},{value:"fromWeb()",id:"fromweb",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-76",level:4},{value:"Since",id:"since-73",level:4},{value:"Inherited from",id:"inherited-from-94",level:4},{value:"getEventListeners()",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-77",level:4},{value:"Since",id:"since-74",level:4},{value:"Inherited from",id:"inherited-from-95",level:4},{value:"listenerCount()",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-78",level:4},{value:"Since",id:"since-75",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Inherited from",id:"inherited-from-96",level:4},{value:"on()",id:"on-1",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-79",level:4},{value:"Since",id:"since-76",level:4},{value:"Inherited from",id:"inherited-from-97",level:4},{value:"once()",id:"once-1",level:3},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options",level:4},{value:"Parameters",id:"parameters-75",level:5},{value:"Returns",id:"returns-80",level:5},{value:"Since",id:"since-77",level:5},{value:"Inherited from",id:"inherited-from-98",level:5},{value:"once(emitter, eventName, options)",id:"onceemitter-eventname-options-1",level:4},{value:"Parameters",id:"parameters-76",level:5},{value:"Returns",id:"returns-81",level:5},{value:"Inherited from",id:"inherited-from-99",level:5},{value:"setMaxListeners()",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-82",level:4},{value:"Since",id:"since-78",level:4},{value:"Inherited from",id:"inherited-from-100",level:4},{value:"toWeb()",id:"toweb",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-83",level:4},{value:"Since",id:"since-79",level:4},{value:"Inherited from",id:"inherited-from-101",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-logtoevtransport",children:"Class: LogToEvTransport"})}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"TransportStream"})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-logtoevtransport",children:"new LogToEvTransport()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new LogToEvTransport"}),"(",(0,i.jsx)(n.code,{children:"opts"}),"?): ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:(0,i.jsx)(n.code,{children:"LogToEvTransport"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"opts?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",children:(0,i.jsx)(n.code,{children:"LogToEvTransport"})})}),"\n",(0,i.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.constructor"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"closed",children:"closed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"closed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Is true after 'close' has been emitted."}),"\n",(0,i.jsx)(n.h4,{id:"since",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.closed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroyed",children:"destroyed"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroyed"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.destroy()"})," has been called."]}),"\n",(0,i.jsx)(n.h4,{id:"since-1",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroyed"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errored",children:"errored"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"errored"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Returns error if the stream has been destroyed with an error."}),"\n",(0,i.jsx)(n.h4,{id:"since-2",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v18.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errored"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"format",children:"format?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"format"}),": ",(0,i.jsx)(n.code,{children:"Format"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.format"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handleexceptions",children:"handleExceptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleExceptions"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleExceptions"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"handlerejections",children:"handleRejections?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"handleRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.handleRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"level",children:"level?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"level"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.level"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"silent"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.silent"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writable",children:"writable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if it is safe to call ",(0,i.jsx)(n.code,{children:"writable.write()"}),", which means\nthe stream has not been destroyed, errored or ended."]}),"\n",(0,i.jsx)(n.h4,{id:"since-3",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writable"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablecorked",children:"writableCorked"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableCorked"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Number of times ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," needs to be\ncalled in order to fully uncork the stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-4",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.2.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableCorked"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableended",children:"writableEnded"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableEnded"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," after ",(0,i.jsx)(n.code,{children:"writable.end()"})," has been called. This property\ndoes not indicate whether the data has been flushed, for this use ",(0,i.jsx)(n.code,{children:"writable.writableFinished"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"since-5",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.9.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableEnded"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablefinished",children:"writableFinished"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableFinished"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is set to ",(0,i.jsx)(n.code,{children:"true"})," immediately before the ",(0,i.jsx)(n.code,{children:"'finish'"})," event is emitted."]}),"\n",(0,i.jsx)(n.h4,{id:"since-6",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.6.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableFinished"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablehighwatermark",children:"writableHighWaterMark"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableHighWaterMark"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Return the value of ",(0,i.jsx)(n.code,{children:"highWaterMark"})," passed when creating this ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-7",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableHighWaterMark"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writablelength",children:"writableLength"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This property contains the number of bytes (or objects) in the queue\nready to be written. The value provides introspection data regarding\nthe status of the ",(0,i.jsx)(n.code,{children:"highWaterMark"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"since-8",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableLength"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableneeddrain",children:"writableNeedDrain"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableNeedDrain"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," if the stream's buffer has been full and stream will emit 'drain'."]}),"\n",(0,i.jsx)(n.h4,{id:"since-9",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableNeedDrain"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writableobjectmode",children:"writableObjectMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"writableObjectMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Getter for the property ",(0,i.jsx)(n.code,{children:"objectMode"})," of a given ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"since-10",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v12.3.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.writableObjectMode"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejectionsymbol",children:"captureRejectionSymbol"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejectionSymbol"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#capturerejectionsymbol",children:(0,i.jsx)(n.code,{children:"captureRejectionSymbol"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejectionSymbol"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capturerejections",children:"captureRejections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"captureRejections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Sets or gets the default captureRejection value for all emitters."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.captureRejections"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"defaultmaxlisteners",children:"defaultMaxListeners"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"defaultMaxListeners"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.defaultMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"errormonitor",children:"errorMonitor"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"errorMonitor"}),": ",(0,i.jsx)(n.em,{children:"typeof"})," ",(0,i.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collector#errormonitor",children:(0,i.jsx)(n.code,{children:"errorMonitor"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This symbol shall be used to install a listener for only monitoring ",(0,i.jsx)(n.code,{children:"'error'"}),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,i.jsx)(n.code,{children:"'error'"})," listeners are called."]}),"\n",(0,i.jsxs)(n.p,{children:["Installing a listener using this symbol does not change the behavior once an\n",(0,i.jsx)(n.code,{children:"'error'"})," event is emitted, therefore the process will still crash if no\nregular ",(0,i.jsx)(n.code,{children:"'error'"})," listener is installed."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.errorMonitor"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"_construct",children:"_construct()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_construct"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._construct"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_destroy",children:"_destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_final",children:"_final()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_final"}),"(",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._final"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_write",children:"_write()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"_write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"_writev",children:"_writev()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_writev"}),"(",(0,i.jsx)(n.code,{children:"chunks"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunks"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream._writev"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"addlistener",children:"addListener()"}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Event emitter\nThe defined events on documents including:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"close"}),"\n",(0,i.jsx)(n.li,{children:"drain"}),"\n",(0,i.jsx)(n.li,{children:"error"}),"\n",(0,i.jsx)(n.li,{children:"finish"}),"\n",(0,i.jsx)(n.li,{children:"pipe"}),"\n",(0,i.jsx)(n.li,{children:"unpipe"}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-1",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-11",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-2",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-12",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-3",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-13",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-4",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-14",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-5",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-15",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.h4,{id:"addlistenerevent-listener-6",children:"addListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"addListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.on(eventName, listener)"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-12",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-16",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.addListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"close",children:"close()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"close"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.close"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cork",children:"cork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method forces all written data to be buffered in memory.\nThe buffered data will be flushed when either the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#uncork",children:"uncork"})," or ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#end",children:"end"})," methods are called."]}),"\n",(0,i.jsxs)(n.p,{children:["The primary intent of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," is to accommodate a situation in which\nseveral small chunks are written to the stream in rapid succession. Instead of\nimmediately forwarding them to the underlying destination, ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"buffers all the chunks until ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," is called, which will pass them\nall to ",(0,i.jsx)(n.code,{children:"writable._writev()"}),", if present. This prevents a head-of-line blocking\nsituation where data is being buffered while waiting for the first small chunk\nto be processed. However, use of ",(0,i.jsx)(n.code,{children:"writable.cork()"})," without implementing",(0,i.jsx)(n.code,{children:"writable._writev()"})," may have an adverse effect on throughput."]}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.uncork()"}),", ",(0,i.jsx)(n.code,{children:"writable._writev()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-17",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.cork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"destroy",children:"destroy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"destroy"}),"(",(0,i.jsx)(n.code,{children:"error"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Destroy the stream. Optionally emit an ",(0,i.jsx)(n.code,{children:"'error'"})," event, and emit a ",(0,i.jsx)(n.code,{children:"'close'"}),"event (unless ",(0,i.jsx)(n.code,{children:"emitClose"})," is set to ",(0,i.jsx)(n.code,{children:"false"}),"). After this call, the writable\nstream has ended and subsequent calls to ",(0,i.jsx)(n.code,{children:"write()"})," or ",(0,i.jsx)(n.code,{children:"end()"})," will result in\nan ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nThis is a destructive and immediate way to destroy a stream. Previous calls to",(0,i.jsx)(n.code,{children:"write()"})," may not have drained, and may trigger an ",(0,i.jsx)(n.code,{children:"ERR_STREAM_DESTROYED"})," error.\nUse ",(0,i.jsx)(n.code,{children:"end()"})," instead of destroy if data should flush before close, or wait for\nthe ",(0,i.jsx)(n.code,{children:"'drain'"})," event before destroying the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["Once ",(0,i.jsx)(n.code,{children:"destroy()"})," has been called any further calls will be a no-op and no\nfurther errors except from ",(0,i.jsx)(n.code,{children:"_destroy()"})," may be emitted as ",(0,i.jsx)(n.code,{children:"'error'"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Implementors should not override this method,\nbut instead implement ",(0,i.jsx)(n.code,{children:"writable._destroy()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"error?"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional, an error to emit with ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-18",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v8.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.destroy"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emit",children:"emit()"}),"\n",(0,i.jsx)(n.h4,{id:"emitevent",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-19",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-1",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-20",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-err",children:"emit(event, err)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"err"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"err"}),": ",(0,i.jsx)(n.code,{children:"Error"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-21",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-2",children:"emit(event)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-22",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-23",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-src-1",children:"emit(event, src)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"src"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"src"}),": ",(0,i.jsx)(n.code,{children:"Readable"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-24",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.h4,{id:"emitevent-args",children:"emit(event, args)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"emit"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ...",(0,i.jsx)(n.code,{children:"args"}),"): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Synchronously calls each of the listeners registered for the event named",(0,i.jsx)(n.code,{children:"eventName"}),", in the order they were registered, passing the supplied arguments\nto each."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.code,{children:"true"})," if the event had listeners, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"args"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"since-25",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.emit"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"end()"}),"\n",(0,i.jsx)(n.h4,{id:"endcb",children:"end(cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.code,{children:"writable.end()"})," method signals that no more data will be written\nto the ",(0,i.jsx)(n.code,{children:"Writable"}),". The optional ",(0,i.jsx)(n.code,{children:"chunk"})," and ",(0,i.jsx)(n.code,{children:"encoding"})," arguments allow one\nfinal additional chunk of data to be written immediately before closing the\nstream."]}),"\n",(0,i.jsxs)(n.p,{children:["Calling the ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#write",children:"write"})," method after calling ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#end",children:"end"})," will raise an error."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"// Write 'hello, ' and then end with 'world!'.\nconst fs = require('fs');\nconst file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// Writing more now is not allowed!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-26",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-cb",children:"end(chunk, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.h4,{id:"endchunk-encoding-cb",children:"end(chunk, encoding, cb)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"end"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"cb"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"cb?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.end"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"eventnames",children:"eventNames()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"eventNames"}),"(): (",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,i.jsx)(n.code,{children:"Symbol"}),"s."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:["(",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-27",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.eventNames"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getmaxlisteners",children:"getMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getMaxListeners"}),"(): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the current max listener value for the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," which is either\nset by ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners(n)"})," or defaults to ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#defaultmaxlisteners",children:"defaultMaxListeners"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-28",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v1.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount",children:"listenerCount()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns the number of listeners listening to the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-29",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v3.2.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listeners",children:"listeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-30",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-30",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.log"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logv",children:"logv()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logv"}),"(",(0,i.jsx)(n.code,{children:"info"}),", ",(0,i.jsx)(n.code,{children:"next"}),"): ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"info"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"next"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-31",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"any"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.logv"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"off",children:"off()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"off"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Alias for ",(0,i.jsx)(n.code,{children:"emitter.removeListener()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-32",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-31",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v10.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.off"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on",children:"on()"}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-32",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-1",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-33",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-2",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-34",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-3",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-35",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-4",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-36",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-5",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-34",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-37",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.h4,{id:"onevent-listener-6",children:"on(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the end of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-35",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-38",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.101"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-36",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-40",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-39",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-1",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-37",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-41",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-40",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-2",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-38",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-42",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-41",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-3",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-39",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-43",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-42",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-4",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-40",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-44",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-43",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-5",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-45",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-44",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceevent-listener-6",children:"once(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),". The\nnext time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this listener is removed and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, event listeners are invoked in the order they are added. The",(0,i.jsx)(n.code,{children:"emitter.prependOnceListener()"})," method can be used as an alternative to add the\nevent listener to the beginning of the listeners array."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-46",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-45",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pipe",children:"pipe()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pipe"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"destination"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"WritableStream"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"destination"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options.end?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.pipe"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependlistener",children:"prependListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-46",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-1",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-47",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-2",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-48",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-3",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-47",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-49",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-4",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-50",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-5",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-51",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependlistenerevent-listener-6",children:"prependListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds the ",(0,i.jsx)(n.code,{children:"listener"})," function to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array for the\nevent named ",(0,i.jsx)(n.code,{children:"eventName"}),". No checks are made to see if the ",(0,i.jsx)(n.code,{children:"listener"})," has\nalready been added. Multiple calls passing the same combination of ",(0,i.jsx)(n.code,{children:"eventName"}),"and ",(0,i.jsx)(n.code,{children:"listener"})," will result in the ",(0,i.jsx)(n.code,{children:"listener"})," being added, and called, multiple\ntimes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-52",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prependoncelistener",children:"prependOnceListener()"}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-53",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-1",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-56",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-54",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-2",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-55",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-3",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-56",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-4",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-57",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-5",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-56",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-58",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.h4,{id:"prependoncelistenerevent-listener-6",children:"prependOnceListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"prependOnceListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Adds a ",(0,i.jsx)(n.strong,{children:"one-time"}),(0,i.jsx)(n.code,{children:"listener"})," function for the event named ",(0,i.jsx)(n.code,{children:"eventName"})," to the ",(0,i.jsx)(n.em,{children:"beginning"})," of the listeners array. The next time ",(0,i.jsx)(n.code,{children:"eventName"})," is triggered, this\nlistener is removed, and then invoked."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-57",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The callback function"}),"\n",(0,i.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-59",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v6.0.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.prependOnceListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rawlisteners",children:"rawListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"rawListeners"}),"(",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),",\nincluding any wrappers (such as those created by ",(0,i.jsx)(n.code,{children:".once()"}),")."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-62",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-60",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v9.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.rawListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeAllListeners"}),"(",(0,i.jsx)(n.code,{children:"event"}),"?): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes all listeners, or those of the specified ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event?"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-63",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-61",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeAllListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-60",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"close"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-62",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-1",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-61",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"drain"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-63",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-2",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"error"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-64",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-84",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-3",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"finish"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-67",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-65",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-85",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-4",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"pipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-68",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-66",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-86",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-5",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:'"unpipe"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-69",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-67",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-87",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.h4,{id:"removelistenerevent-listener-6",children:"removeListener(event, listener)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeListener"}),"(",(0,i.jsx)(n.code,{children:"event"}),", ",(0,i.jsx)(n.code,{children:"listener"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Removes the specified ",(0,i.jsx)(n.code,{children:"listener"})," from the listener array for the event named",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"removeListener()"})," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,i.jsx)(n.code,{children:"eventName"}),", then ",(0,i.jsx)(n.code,{children:"removeListener()"})," must be\ncalled multiple times to remove each instance."]}),"\n",(0,i.jsxs)(n.p,{children:["Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,i.jsx)(n.code,{children:"removeListener()"})," or ",(0,i.jsx)(n.code,{children:"removeAllListeners()"})," calls ",(0,i.jsx)(n.em,{children:"after"})," emitting and ",(0,i.jsx)(n.em,{children:"before"})," the last listener finishes execution\nwill not remove them from",(0,i.jsx)(n.code,{children:"emit()"})," in progress. Subsequent events behave as expected."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,i.jsx)(n.em,{children:"after"})," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,i.jsx)(n.code,{children:"emitter.listeners()"})," method will need to be recreated."]}),"\n",(0,i.jsxs)(n.p,{children:["When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,i.jsx)(n.code,{children:"removeListener()"})," will remove the most\nrecently added instance. In the example the ",(0,i.jsx)(n.code,{children:"once('ping')"}),"listener is removed:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-66",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"event"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h5,{id:"since-68",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.1.26"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-88",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.removeListener"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setdefaultencoding",children:"setDefaultEncoding()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setDefaultEncoding"}),"(",(0,i.jsx)(n.code,{children:"encoding"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.setDefaultEncoding()"})," method sets the default ",(0,i.jsx)(n.code,{children:"encoding"})," for a ",(0,i.jsx)(n.code,{children:"Writable"})," stream."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsx)(n.p,{children:"The new default encoding"}),"\n",(0,i.jsx)(n.h4,{id:"returns-71",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-69",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.15"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-89",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setDefaultEncoding"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"): ",(0,i.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["By default ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s will print a warning if more than ",(0,i.jsx)(n.code,{children:"10"})," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,i.jsx)(n.code,{children:"emitter.setMaxListeners()"})," method allows the limit to be\nmodified for this specific ",(0,i.jsx)(n.code,{children:"EventEmitter"})," instance. The value can be set to",(0,i.jsx)(n.code,{children:"Infinity"})," (or ",(0,i.jsx)(n.code,{children:"0"}),") to indicate an unlimited number of listeners."]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a reference to the ",(0,i.jsx)(n.code,{children:"EventEmitter"}),", so that calls can be chained."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"this"})}),"\n",(0,i.jsx)(n.h4,{id:"since-70",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.3.5"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-90",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"uncork",children:"uncork()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"uncork"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," method flushes all data buffered since ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#cork",children:"cork"})," was called."]}),"\n",(0,i.jsxs)(n.p,{children:["When using ",(0,i.jsx)(n.code,{children:"writable.cork()"})," and ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," to manage the buffering\nof writes to a stream, defer calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," using",(0,i.jsx)(n.code,{children:"process.nextTick()"}),". Doing so allows batching of all",(0,i.jsx)(n.code,{children:"writable.write()"})," calls that occur within a given Node.js event\nloop phase."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.write('data ');\nprocess.nextTick(() => stream.uncork());\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If the ",(0,i.jsx)(n.code,{children:"writable.cork()"})," method is called multiple times on a stream, the\nsame number of calls to ",(0,i.jsx)(n.code,{children:"writable.uncork()"})," must be called to flush the buffered\ndata."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"stream.cork();\nstream.write('some ');\nstream.cork();\nstream.write('data ');\nprocess.nextTick(() => {\n stream.uncork();\n // The data will not be flushed until uncork() is called a second time.\n stream.uncork();\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["See also: ",(0,i.jsx)(n.code,{children:"writable.cork()"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-71",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.11.2"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-91",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.uncork"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"write",children:"write()"}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-callback",children:"write(chunk, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"writable.write()"})," method writes some data to the stream, and calls the\nsupplied ",(0,i.jsx)(n.code,{children:"callback"})," once the data has been fully handled. If an error\noccurs, the ",(0,i.jsx)(n.code,{children:"callback"})," will be called with the error as its\nfirst argument. The ",(0,i.jsx)(n.code,{children:"callback"})," is called asynchronously and before ",(0,i.jsx)(n.code,{children:"'error'"})," is\nemitted."]}),"\n",(0,i.jsxs)(n.p,{children:["The return value is ",(0,i.jsx)(n.code,{children:"true"})," if the internal buffer is less than the",(0,i.jsx)(n.code,{children:"highWaterMark"})," configured when the stream was created after admitting ",(0,i.jsx)(n.code,{children:"chunk"}),".\nIf ",(0,i.jsx)(n.code,{children:"false"})," is returned, further attempts to write data to the stream should\nstop until the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted."]}),"\n",(0,i.jsxs)(n.p,{children:["While a stream is not draining, calls to ",(0,i.jsx)(n.code,{children:"write()"})," will buffer ",(0,i.jsx)(n.code,{children:"chunk"}),", and\nreturn false. Once all currently buffered chunks are drained (accepted for\ndelivery by the operating system), the ",(0,i.jsx)(n.code,{children:"'drain'"})," event will be emitted.\nOnce ",(0,i.jsx)(n.code,{children:"write()"})," returns false, do not write more chunks\nuntil the ",(0,i.jsx)(n.code,{children:"'drain'"})," event is emitted. While calling ",(0,i.jsx)(n.code,{children:"write()"})," on a stream that\nis not draining is allowed, Node.js will buffer all written chunks until\nmaximum memory usage occurs, at which point it will abort unconditionally.\nEven before it aborts, high memory usage will cause poor garbage collector\nperformance and high RSS (which is not typically released back to the system,\neven after the memory is no longer required). Since TCP sockets may never\ndrain if the remote peer does not read the data, writing a socket that is\nnot draining may lead to a remotely exploitable vulnerability."]}),"\n",(0,i.jsxs)(n.p,{children:["Writing data while the stream is not draining is particularly\nproblematic for a ",(0,i.jsx)(n.code,{children:"Transform"}),", because the ",(0,i.jsx)(n.code,{children:"Transform"})," streams are paused\nby default until they are piped or a ",(0,i.jsx)(n.code,{children:"'data'"})," or ",(0,i.jsx)(n.code,{children:"'readable'"})," event handler\nis added."]}),"\n",(0,i.jsxs)(n.p,{children:["If the data to be written can be generated or fetched on demand, it is\nrecommended to encapsulate the logic into a ",(0,i.jsx)(n.code,{children:"Readable"})," and use ",(0,i.jsx)(n.a,{href:"/docs/reference/logging/custom_transport/classes/LogToEvTransport#pipe",children:"pipe"}),". However, if calling ",(0,i.jsx)(n.code,{children:"write()"})," is preferred, it is\npossible to respect backpressure and avoid memory issues using the ",(0,i.jsx)(n.code,{children:"'drain'"})," event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"function write(data, cb) {\n if (!stream.write(data)) {\n stream.once('drain', cb);\n } else {\n process.nextTick(cb);\n }\n}\n\n// Wait for cb to be called before doing any other write.\nwrite('hello', () => {\n console.log('Write completed, do more writes now.');\n});\n"})}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"Writable"})," stream in object mode will always ignore the ",(0,i.jsx)(n.code,{children:"encoding"})," argument."]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-69",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["Optional data to write. For streams not operating in object mode, ",(0,i.jsx)(n.code,{children:"chunk"})," must be a string, ",(0,i.jsx)(n.code,{children:"Buffer"})," or ",(0,i.jsx)(n.code,{children:"Uint8Array"}),". For object mode streams, ",(0,i.jsx)(n.code,{children:"chunk"})," may be any\nJavaScript value other than ",(0,i.jsx)(n.code,{children:"null"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.p,{children:"Callback for when this chunk of data is flushed."}),"\n",(0,i.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"false"})," if the stream wishes for the calling code to wait for the ",(0,i.jsx)(n.code,{children:"'drain'"})," event to be emitted before continuing to write additional data; otherwise ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsx)(n.h5,{id:"since-72",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.4"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-92",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.h4,{id:"writechunk-encoding-callback",children:"write(chunk, encoding, callback)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"write"}),"(",(0,i.jsx)(n.code,{children:"chunk"}),", ",(0,i.jsx)(n.code,{children:"encoding"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-70",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"chunk"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback?"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-93",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.write"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fromweb",children:"fromWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"fromWeb"}),"(",(0,i.jsx)(n.code,{children:"writableStream"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a ",(0,i.jsx)(n.code,{children:"Writable"})," from a web ",(0,i.jsx)(n.code,{children:"WritableStream"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"writableStream"}),": ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Pick"}),"<",(0,i.jsx)(n.code,{children:"WritableOptions"}),", ",(0,i.jsx)(n.code,{children:'"signal"'})," | ",(0,i.jsx)(n.code,{children:'"decodeStrings"'})," | ",(0,i.jsx)(n.code,{children:'"highWaterMark"'})," | ",(0,i.jsx)(n.code,{children:'"objectMode"'}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-76",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Writable"})}),"\n",(0,i.jsx)(n.h4,{id:"since-73",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-94",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.fromWeb"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"geteventlisteners",children:"getEventListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"getEventListeners"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"name"}),"): ",(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Returns a copy of the array of listeners for the event named ",(0,i.jsx)(n.code,{children:"eventName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventEmitter"}),"s this behaves exactly the same as calling ",(0,i.jsx)(n.code,{children:".listeners"})," on\nthe emitter."]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"EventTarget"}),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-77",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Function"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"since-74",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.2.0, v14.17.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-95",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.getEventListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listenercount-1",children:(0,i.jsx)(n.del,{children:"listenerCount()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"listenerCount"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),"): ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A class method that returns the number of listeners for the given ",(0,i.jsx)(n.code,{children:"eventName"}),"registered on the given ",(0,i.jsx)(n.code,{children:"emitter"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsx)(n.p,{children:"The emitter to query"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsx)(n.p,{children:"The event name"}),"\n",(0,i.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"number"})}),"\n",(0,i.jsx)(n.h4,{id:"since-75",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v0.9.12"}),"\n",(0,i.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(n.p,{children:["Since v3.2.0 - Use ",(0,i.jsx)(n.code,{children:"listenerCount"})," instead."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-96",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.listenerCount"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"on-1",children:"on()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"on"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Returns an ",(0,i.jsx)(n.code,{children:"AsyncIterator"})," that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events. It will throw\nif the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"}),". It removes all listeners when\nexiting the loop. The ",(0,i.jsx)(n.code,{children:"value"})," returned by each iteration is an array\ncomposed of the emitted event arguments."]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting on events:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"EventEmitter"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The name of the event being listened for"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"AsyncIterableIterator"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["that iterates ",(0,i.jsx)(n.code,{children:"eventName"})," events emitted by the ",(0,i.jsx)(n.code,{children:"emitter"})]}),"\n",(0,i.jsx)(n.h4,{id:"since-76",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v13.6.0, v12.16.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-97",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.on"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"once-1",children:"once()"}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Creates a ",(0,i.jsx)(n.code,{children:"Promise"})," that is fulfilled when the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits the given\nevent or that is rejected if the ",(0,i.jsx)(n.code,{children:"EventEmitter"})," emits ",(0,i.jsx)(n.code,{children:"'error'"})," while waiting.\nThe ",(0,i.jsx)(n.code,{children:"Promise"})," will resolve with an array of all the arguments emitted to the\ngiven event."]}),"\n",(0,i.jsxs)(n.p,{children:["This method is intentionally generic and works with the web platform ",(0,i.jsx)(n.a,{href:"https://dom.spec.whatwg.org/#interface-eventtarget",children:"EventTarget"})," interface, which has no special",(0,i.jsx)(n.code,{children:"'error'"})," event\nsemantics and does not listen to the ",(0,i.jsx)(n.code,{children:"'error'"})," event."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The special handling of the ",(0,i.jsx)(n.code,{children:"'error'"})," event is only used when ",(0,i.jsx)(n.code,{children:"events.once()"}),"is used to wait for another event. If ",(0,i.jsx)(n.code,{children:"events.once()"})," is used to wait for the\n'",(0,i.jsx)(n.code,{children:"error'"})," event itself, then it is treated as any other kind of event without\nspecial handling:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n"})}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.code,{children:"AbortSignal"})," can be used to cancel waiting for the event:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-75",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"NodeEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"symbol"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-80",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"since-77",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v11.13.0, v10.16.0"}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-98",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.h4,{id:"onceemitter-eventname-options-1",children:"once(emitter, eventName, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"once"}),"(",(0,i.jsx)(n.code,{children:"emitter"}),", ",(0,i.jsx)(n.code,{children:"eventName"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"parameters-76",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"emitter"}),": ",(0,i.jsx)(n.code,{children:"DOMEventTarget"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"eventName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"StaticEventEmitterOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-81",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"any"}),"[]>"]}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-99",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.once"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"setmaxlisteners-1",children:"setMaxListeners()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"setMaxListeners"}),"(",(0,i.jsx)(n.code,{children:"n"}),"?, ...",(0,i.jsx)(n.code,{children:"eventTargets"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n"})}),"\n",(0,i.jsx)(n.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"n?"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n",(0,i.jsxs)(n.p,{children:["A non-negative number. The maximum number of listeners per ",(0,i.jsx)(n.code,{children:"EventTarget"})," event."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"eventTargets?"}),": (",(0,i.jsx)(n.code,{children:"EventEmitter"})," | ",(0,i.jsx)(n.code,{children:"DOMEventTarget"}),")[]"]}),"\n",(0,i.jsx)(n.h4,{id:"returns-82",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"since-78",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v15.4.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-100",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.setMaxListeners"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"toweb",children:"toWeb()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"toWeb"}),"(",(0,i.jsx)(n.code,{children:"streamWritable"}),"): ",(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"Experimental"})})}),"\n",(0,i.jsxs)(n.p,{children:["A utility method for creating a web ",(0,i.jsx)(n.code,{children:"WritableStream"})," from a ",(0,i.jsx)(n.code,{children:"Writable"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"streamWritable"}),": ",(0,i.jsx)(n.code,{children:"Writable"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-83",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"WritableStream"}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"since-79",children:"Since"}),"\n",(0,i.jsx)(n.p,{children:"v17.0.0"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-101",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TransportStream.toWeb"})})]})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>d});var i=r(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd96faf0.b042e38b.js b/assets/js/fd96faf0.b042e38b.js new file mode 100644 index 0000000000..e6dc6d651a --- /dev/null +++ b/assets/js/fd96faf0.b042e38b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4113],{877:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>a,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var s=r(4848),i=r(8453);const l={},d="Class: Collection",c={id:"reference/structures/Collector/classes/Collection",title:"Class: Collection\\",description:"Extends",source:"@site/docs/reference/structures/Collector/classes/Collection.md",sourceDirName:"reference/structures/Collector/classes",slug:"/reference/structures/Collector/classes/Collection",permalink:"/docs/reference/structures/Collector/classes/Collection",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/classes/Collection.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/Collector",permalink:"/docs/reference/structures/Collector/"},next:{title:"Class: Collector",permalink:"/docs/reference/structures/Collector/classes/Collector"}},h={},t=[{value:"Extends",id:"extends",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Collection()",id:"new-collection",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"new Collection()",id:"new-collection-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Properties",id:"properties",level:2},{value:"[toStringTag]",id:"tostringtag",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"constructor",id:"constructor",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"size",id:"size",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"[species]",id:"species",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"[iterator]()",id:"iterator",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"at()",id:"at",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"clear()",id:"clear",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"clone()",id:"clone",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"concat()",id:"concat",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Example",id:"example-1",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"difference()",id:"difference",level:3},{value:"Type Parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"each()",id:"each",level:3},{value:"each(fn)",id:"eachfn",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Example",id:"example-2",level:5},{value:"Inherited from",id:"inherited-from-13",level:5},{value:"each(fn, thisArg)",id:"eachfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-2",level:5},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Inherited from",id:"inherited-from-14",level:5},{value:"ensure()",id:"ensure",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-3",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"entries()",id:"entries",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"equals()",id:"equals",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"every()",id:"every",level:3},{value:"every(fn)",id:"everyfn",level:4},{value:"Type Parameters",id:"type-parameters-3",level:5},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-14",level:5},{value:"Example",id:"example-4",level:5},{value:"Inherited from",id:"inherited-from-18",level:5},{value:"every(fn)",id:"everyfn-1",level:4},{value:"Type Parameters",id:"type-parameters-4",level:5},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-15",level:5},{value:"Inherited from",id:"inherited-from-19",level:5},{value:"every(fn)",id:"everyfn-2",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Inherited from",id:"inherited-from-20",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-5",level:5},{value:"Parameters",id:"parameters-13",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Inherited from",id:"inherited-from-21",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-6",level:5},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Inherited from",id:"inherited-from-22",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-7",level:5},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Inherited from",id:"inherited-from-23",level:5},{value:"filter()",id:"filter",level:3},{value:"filter(fn)",id:"filterfn",level:4},{value:"Type Parameters",id:"type-parameters-8",level:5},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Example",id:"example-5",level:5},{value:"Inherited from",id:"inherited-from-24",level:5},{value:"filter(fn)",id:"filterfn-1",level:4},{value:"Type Parameters",id:"type-parameters-9",level:5},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"filter(fn)",id:"filterfn-2",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-10",level:5},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-11",level:5},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-12",level:5},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"find()",id:"find",level:3},{value:"find(fn)",id:"findfn",level:4},{value:"Type Parameters",id:"type-parameters-13",level:5},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-26",level:5},{value:"Example",id:"example-6",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"find(fn)",id:"findfn-1",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-27",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"find(fn, thisArg)",id:"findfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-14",level:5},{value:"Parameters",id:"parameters-24",level:5},{value:"Returns",id:"returns-28",level:5},{value:"Inherited from",id:"inherited-from-32",level:5},{value:"find(fn, thisArg)",id:"findfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-15",level:5},{value:"Parameters",id:"parameters-25",level:5},{value:"Returns",id:"returns-29",level:5},{value:"Inherited from",id:"inherited-from-33",level:5},{value:"findKey()",id:"findkey",level:3},{value:"findKey(fn)",id:"findkeyfn",level:4},{value:"Type Parameters",id:"type-parameters-16",level:5},{value:"Parameters",id:"parameters-26",level:5},{value:"Returns",id:"returns-30",level:5},{value:"Example",id:"example-7",level:5},{value:"Inherited from",id:"inherited-from-34",level:5},{value:"findKey(fn)",id:"findkeyfn-1",level:4},{value:"Parameters",id:"parameters-27",level:5},{value:"Returns",id:"returns-31",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"findKey(fn, thisArg)",id:"findkeyfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-17",level:5},{value:"Parameters",id:"parameters-28",level:5},{value:"Returns",id:"returns-32",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"findKey(fn, thisArg)",id:"findkeyfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-18",level:5},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"first()",id:"first",level:3},{value:"first()",id:"first-1",level:4},{value:"Returns",id:"returns-34",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"first(amount)",id:"firstamount",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"firstKey()",id:"firstkey",level:3},{value:"firstKey()",id:"firstkey-1",level:4},{value:"Returns",id:"returns-36",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"firstKey(amount)",id:"firstkeyamount",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"flatMap()",id:"flatmap",level:3},{value:"flatMap(fn)",id:"flatmapfn",level:4},{value:"Type Parameters",id:"type-parameters-19",level:5},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Example",id:"example-8",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"flatMap(fn, thisArg)",id:"flatmapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-20",level:5},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"forEach()",id:"foreach",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"hasAll()",id:"hasall",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"hasAny()",id:"hasany",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"intersect()",id:"intersect",level:3},{value:"Type Parameters",id:"type-parameters-21",level:4},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"keyAt()",id:"keyat",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"keys()",id:"keys",level:3},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-51",level:4},{value:"last()",id:"last",level:3},{value:"last()",id:"last-1",level:4},{value:"Returns",id:"returns-48",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"last(amount)",id:"lastamount",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"lastKey()",id:"lastkey",level:3},{value:"lastKey()",id:"lastkey-1",level:4},{value:"Returns",id:"returns-50",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"lastKey(amount)",id:"lastkeyamount",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"map()",id:"map",level:3},{value:"map(fn)",id:"mapfn",level:4},{value:"Type Parameters",id:"type-parameters-22",level:5},{value:"Parameters",id:"parameters-43",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Example",id:"example-9",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"map(fn, thisArg)",id:"mapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-23",level:5},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"mapValues()",id:"mapvalues",level:3},{value:"mapValues(fn)",id:"mapvaluesfn",level:4},{value:"Type Parameters",id:"type-parameters-24",level:5},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Example",id:"example-10",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"mapValues(fn, thisArg)",id:"mapvaluesfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-25",level:5},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"merge()",id:"merge",level:3},{value:"Type Parameters",id:"type-parameters-26",level:4},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Examples",id:"examples",level:4},{value:"Inherited from",id:"inherited-from-60",level:4},{value:"partition()",id:"partition",level:3},{value:"partition(fn)",id:"partitionfn",level:4},{value:"Type Parameters",id:"type-parameters-27",level:5},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Example",id:"example-11",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"partition(fn)",id:"partitionfn-1",level:4},{value:"Type Parameters",id:"type-parameters-28",level:5},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"partition(fn)",id:"partitionfn-2",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-29",level:5},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-30",level:5},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Inherited from",id:"inherited-from-65",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-31",level:5},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-62",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"random()",id:"random",level:3},{value:"random()",id:"random-1",level:4},{value:"Returns",id:"returns-63",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"random(amount)",id:"randomamount",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"randomKey()",id:"randomkey",level:3},{value:"randomKey()",id:"randomkey-1",level:4},{value:"Returns",id:"returns-65",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"randomKey(amount)",id:"randomkeyamount",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"reduce()",id:"reduce",level:3},{value:"Type Parameters",id:"type-parameters-32",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-67",level:4},{value:"Example",id:"example-12",level:4},{value:"Inherited from",id:"inherited-from-71",level:4},{value:"reverse()",id:"reverse",level:3},{value:"Returns",id:"returns-68",level:4},{value:"Inherited from",id:"inherited-from-72",level:4},{value:"set()",id:"set",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-69",level:4},{value:"Inherited from",id:"inherited-from-73",level:4},{value:"some()",id:"some",level:3},{value:"some(fn)",id:"somefn",level:4},{value:"Parameters",id:"parameters-58",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Example",id:"example-13",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"some(fn, thisArg)",id:"somefn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-33",level:5},{value:"Parameters",id:"parameters-59",level:5},{value:"Returns",id:"returns-71",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"sort()",id:"sort",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Example",id:"example-14",level:4},{value:"Inherited from",id:"inherited-from-76",level:4},{value:"sorted()",id:"sorted",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Example",id:"example-15",level:4},{value:"Inherited from",id:"inherited-from-77",level:4},{value:"sweep()",id:"sweep",level:3},{value:"sweep(fn)",id:"sweepfn",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"sweep(fn, thisArg)",id:"sweepfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-34",level:5},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"tap()",id:"tap",level:3},{value:"tap(fn)",id:"tapfn",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-76",level:5},{value:"Example",id:"example-16",level:5},{value:"Inherited from",id:"inherited-from-80",level:5},{value:"tap(fn, thisArg)",id:"tapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-35",level:5},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-77",level:5},{value:"Inherited from",id:"inherited-from-81",level:5},{value:"toJSON()",id:"tojson",level:3},{value:"Returns",id:"returns-78",level:4},{value:"Overrides",id:"overrides",level:4},{value:"values()",id:"values",level:3},{value:"Returns",id:"returns-79",level:4},{value:"Inherited from",id:"inherited-from-82",level:4},{value:"combineEntries()",id:"combineentries",level:3},{value:"Type Parameters",id:"type-parameters-36",level:4},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-80",level:4},{value:"Example",id:"example-17",level:4},{value:"Inherited from",id:"inherited-from-83",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"class-collectionk-v",children:"Class: Collection"})}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V"})]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-collection",children:"new Collection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"entries"}),"?): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"entries?"}),": readonly readonly [",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"][]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.h3,{id:"new-collection-1",children:"new Collection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"iterable"}),"?): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"iterable?"}),": ",(0,s.jsx)(n.code,{children:"Iterable"}),""]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"tostringtag",children:"[toStringTag]"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"[toStringTag]"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[toStringTag]"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"constructor"}),": ",(0,s.jsx)(n.code,{children:"CollectionConstructor"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The initial value of Object.prototype.constructor is the standard built-in Object constructor."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.size"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"species",children:"[species]"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"[species]"}),": ",(0,s.jsx)(n.code,{children:"MapConstructor"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[species]"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"iterator",children:"[iterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[iterator]"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of entries in the map."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[iterator]"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"at",children:"at()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"at"}),"(",(0,s.jsx)(n.code,{children:"index"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at",children:"Array.at()"}),".\nReturns the item at a given index, allowing for positive and negative integers.\nNegative integers count back from the last item in the collection."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"The index of the element to obtain"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.at"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clear",children:"clear()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clear"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.clear"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clone",children:"clone()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clone"}),"(): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates an identical shallow copy of this collection."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const newColl = someColl.clone();\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.clone"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"concat",children:"concat()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"concat"}),"(...",(0,s.jsx)(n.code,{children:"collections"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Combines this collection with others into a new collection. None of the source collections are modified."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"collections"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">[]"]}),"\n",(0,s.jsx)(n.p,{children:"Collections to merge"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.concat"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"true if an element in the Map existed and has been removed, or false if the element does not exist."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.delete"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"difference",children:"difference()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"difference"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"other"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"})," | ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The difference method returns a new structure containing items where the key is present in one of the original structures but not the other."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to filter against"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"})," | ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.difference"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"each",children:"each()"}),"\n",(0,s.jsx)(n.h4,{id:"eachfn",children:"each(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"each"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach",children:"Map.forEach()"}),",\nbut returns the collection instead of undefined."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute for each element"}),"\n",(0,s.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection\n .each(user => console.log(user.username))\n .filter(user => user.bot)\n .each(user => console.log(user.username));\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.each"})}),"\n",(0,s.jsx)(n.h4,{id:"eachfn-thisarg",children:"each(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"each"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.each"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ensure",children:"ensure()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ensure"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"defaultValueGenerator"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to get if it exists, or set otherwise"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"defaultValueGenerator"})]}),"\n",(0,s.jsx)(n.p,{children:"A function that generates the default value"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.ensure(guildId, () => defaultGuildConfig);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.ensure"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entries",children:"entries()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"entries"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of key, value pairs for every entry in the map."}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.entries"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"equals",children:"equals()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"equals"}),"(",(0,s.jsx)(n.code,{children:"collection"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if this collection shares identical items with another.\nThis is different to checking for equality using equal-signs, because\nthe collections may be different objects, but contain the same data."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"collection"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Collection to compare with"}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"Whether the collections have identical contents"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.equals"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"every",children:"every()"}),"\n",(0,s.jsx)(n.h4,{id:"everyfn",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Checks if all items passes a test. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every",children:"Array.every()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.every(user => !user.bot);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-1",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-2",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg-1",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg-2",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsx)(n.h4,{id:"filterfn",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter",children:"Array.filter()"}),",\nbut returns a Collection instead of an Array."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-8",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.filter(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-1",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-9",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-2",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-10",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg-1",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-11",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg-2",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-12",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"find",children:"find()"}),"\n",(0,s.jsx)(n.h4,{id:"findfn",children:"find(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"V2"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Searches for a single item where the given function returns a truthy value. This behaves like\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find",children:"Array.find()"}),".\n",(0,s.jsxs)("warn",{children:["All collections used in Discord.js are mapped using their ",(0,s.jsx)(n.code,{children:"id"})," property, and if you want to find by id you\nshould use the ",(0,s.jsx)(n.code,{children:"get"})," method. See\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get",children:"MDN"})," for details."]})]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-13",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V2"})}),"\n",(0,s.jsx)(n.h5,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.find(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-1",children:"find(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-thisarg",children:"find(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"V2"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-14",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V2"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-thisarg-1",children:"find(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-15",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"findkey",children:"findKey()"}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn",children:"findKey(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"K2"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Searches for the key of a single item where the given function returns a truthy value. This behaves like\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex",children:"Array.findIndex()"}),",\nbut returns the key rather than the positional index."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-16",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K2"})}),"\n",(0,s.jsx)(n.h5,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.findKey(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-1",children:"findKey(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-thisarg",children:"findKey(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"K2"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-17",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K2"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-thisarg-1",children:"findKey(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-18",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"first",children:"first()"}),"\n",(0,s.jsx)(n.h4,{id:"first-1",children:"first()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"first"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the first value(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values, starting from the end if amount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.first"})}),"\n",(0,s.jsx)(n.h4,{id:"firstamount",children:"first(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"first"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.first"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"firstkey",children:"firstKey()"}),"\n",(0,s.jsx)(n.h4,{id:"firstkey-1",children:"firstKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"firstKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the first key(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array of keys, starting from the end if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.firstKey"})}),"\n",(0,s.jsx)(n.h4,{id:"firstkeyamount",children:"firstKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"firstKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.firstKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"flatmap",children:"flatMap()"}),"\n",(0,s.jsx)(n.h4,{id:"flatmapfn",children:"flatMap(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"flatMap"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap",children:"Array.flatMap()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-19",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces a new Collection"}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.flatMap(guild => guild.members.cache);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.flatMap"})}),"\n",(0,s.jsx)(n.h4,{id:"flatmapfn-thisarg",children:"flatMap(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"flatMap"}),"<",(0,s.jsx)(n.code,{children:"T"}),", ",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-20",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.flatMap"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"foreach",children:"forEach()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"forEach"}),"(",(0,s.jsx)(n.code,{children:"callbackfn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Executes a provided function once per each key/value pair in the Map, in insertion order."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"callbackfn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-40",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.forEach"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-41",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.get"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"has"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-42",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"boolean indicating whether an element with the specified key exists or not."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.has"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasall",children:"hasAll()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hasAll"}),"(...",(0,s.jsx)(n.code,{children:"keys"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if all of the elements exist in the collection."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"keys"}),": ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The keys of the elements to check for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-43",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if all of the elements exist, ",(0,s.jsx)(n.code,{children:"false"})," if at least one does not exist."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.hasAll"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasany",children:"hasAny()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hasAny"}),"(...",(0,s.jsx)(n.code,{children:"keys"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if any of the elements exist in the collection."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"keys"}),": ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The keys of the elements to check for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-44",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if any of the elements exist, ",(0,s.jsx)(n.code,{children:"false"})," if none exist."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.hasAny"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"intersect",children:"intersect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"intersect"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"other"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The intersect method returns a new structure containing items where the keys and values are present in both original structures."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-21",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to filter against"}),"\n",(0,s.jsx)(n.h4,{id:"returns-45",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.intersect"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"keyat",children:"keyAt()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"keyAt"}),"(",(0,s.jsx)(n.code,{children:"index"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at",children:"Array.at()"}),".\nReturns the key at a given index, allowing for positive and negative integers.\nNegative integers count back from the last item in the collection."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"The index of the key to obtain"}),"\n",(0,s.jsx)(n.h4,{id:"returns-46",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.keyAt"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"keys",children:"keys()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"keys"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"K"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of keys in the map"}),"\n",(0,s.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"K"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.keys"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last()"}),"\n",(0,s.jsx)(n.h4,{id:"last-1",children:"last()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"last"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the last value(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values, starting from the start if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.last"})}),"\n",(0,s.jsx)(n.h4,{id:"lastamount",children:"last(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"last"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.last"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"lastkey",children:"lastKey()"}),"\n",(0,s.jsx)(n.h4,{id:"lastkey-1",children:"lastKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lastKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the last key(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array of keys, starting from the start if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.lastKey"})}),"\n",(0,s.jsx)(n.h4,{id:"lastkeyamount",children:"lastKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lastKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.lastKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"map",children:"map()"}),"\n",(0,s.jsx)(n.h4,{id:"mapfn",children:"map(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"map"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item to another value into an array. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map",children:"Array.map()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-22",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-43",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces an element of the new array, taking three arguments"}),"\n",(0,s.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.map(user => user.tag);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.map"})}),"\n",(0,s.jsx)(n.h4,{id:"mapfn-thisarg",children:"map(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"map"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-23",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.map"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mapvalues",children:"mapValues()"}),"\n",(0,s.jsx)(n.h4,{id:"mapvaluesfn",children:"mapValues(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapValues"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item to another value into a collection. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map",children:"Array.map()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-24",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces an element of the new collection, taking three arguments"}),"\n",(0,s.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.mapValues(user => user.tag);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.mapValues"})}),"\n",(0,s.jsx)(n.h4,{id:"mapvaluesfn-thisarg",children:"mapValues(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapValues"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-25",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.mapValues"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"merge",children:"merge()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"merge"}),"<",(0,s.jsx)(n.code,{children:"T"}),", ",(0,s.jsx)(n.code,{children:"R"}),">(",(0,s.jsx)(n.code,{children:"other"}),", ",(0,s.jsx)(n.code,{children:"whenInSelf"}),", ",(0,s.jsx)(n.code,{children:"whenInOther"}),", ",(0,s.jsx)(n.code,{children:"whenInBoth"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Merges two Collections together into a new Collection."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-26",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"R"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to merge with"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInSelf"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry only exists in this Collection"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInOther"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry only exists in the other Collection"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInBoth"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry exists in both Collections"}),"\n",(0,s.jsx)(n.h4,{id:"returns-56",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// Sums up the entries in two collections.\ncoll.merge(\n other,\n x => ({ keep: true, value: x }),\n y => ({ keep: true, value: y }),\n (x, y) => ({ keep: true, value: x + y }),\n);\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// Intersects two collections in a left-biased manner.\ncoll.merge(\n other,\n x => ({ keep: false }),\n y => ({ keep: false }),\n (x, _) => ({ keep: true, value: x }),\n);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.merge"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"partition",children:"partition()"}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Partitions the collection into two collections where the first collection\ncontains the items that passed and the second contains the items that failed."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-27",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const [big, small] = collection.partition(guild => guild.memberCount > 250);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-1",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-28",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-2",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-29",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg-1",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-30",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg-2",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-31",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-62",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"random",children:"random()"}),"\n",(0,s.jsx)(n.h4,{id:"random-1",children:"random()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"random"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains unique random value(s) from this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-63",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.random"})}),"\n",(0,s.jsx)(n.h4,{id:"randomamount",children:"random(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"random"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.random"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"randomkey",children:"randomKey()"}),"\n",(0,s.jsx)(n.h4,{id:"randomkey-1",children:"randomKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"randomKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains unique random key(s) from this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.randomKey"})}),"\n",(0,s.jsx)(n.h4,{id:"randomkeyamount",children:"randomKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"randomKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.randomKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reduce",children:"reduce()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reduce"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"initialValue"}),"?): ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Applies a function to produce a single value. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce",children:"Array.reduce()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-32",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["Function used to reduce, taking four arguments; ",(0,s.jsx)(n.code,{children:"accumulator"}),", ",(0,s.jsx)(n.code,{children:"currentValue"}),", ",(0,s.jsx)(n.code,{children:"currentKey"}),",\nand ",(0,s.jsx)(n.code,{children:"collection"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"initialValue?"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.p,{children:"Starting value for the accumulator"}),"\n",(0,s.jsx)(n.h4,{id:"returns-67",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"T"})}),"\n",(0,s.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.reduce((acc, guild) => acc + guild.memberCount, 0);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.reduce"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reverse",children:"reverse()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reverse"}),"(): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse",children:"Array.reverse()"}),"\nbut returns a Collection instead of an Array."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-68",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.reverse"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"set",children:"set()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"set"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"V"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-69",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.set"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"some",children:"some()"}),"\n",(0,s.jsx)(n.h4,{id:"somefn",children:"some(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"some"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Checks if there exists an item that passes a test. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some",children:"Array.some()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-58",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"example-13",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.some(user => user.discriminator === '0000');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.some"})}),"\n",(0,s.jsx)(n.h4,{id:"somefn-thisarg",children:"some(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"some"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-33",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-59",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-71",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.some"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sort",children:"sort()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sort"}),"(",(0,s.jsx)(n.code,{children:"compareFunction"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sort method sorts the items of a collection in place and returns it.\nThe sort is not necessarily stable in Node 10 or older.\nThe default sort order is according to string Unicode code points."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"compareFunction?"}),": ",(0,s.jsx)(n.code,{children:"Comparator"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a function that defines the sort order.\nIf omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element."}),"\n",(0,s.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"example-14",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sort"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sorted",children:"sorted()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sorted"}),"(",(0,s.jsx)(n.code,{children:"compareFunction"}),"?): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sorted method sorts the items of a collection and returns it.\nThe sort is not necessarily stable in Node 10 or older.\nThe default sort order is according to string Unicode code points."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"compareFunction?"}),": ",(0,s.jsx)(n.code,{children:"Comparator"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a function that defines the sort order.\nIf omitted, the collection is sorted according to each character's Unicode code point value,\naccording to the string conversion of each element."}),"\n",(0,s.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-15",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sorted"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sweep",children:"sweep()"}),"\n",(0,s.jsx)(n.h4,{id:"sweepfn",children:"sweep(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sweep"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Removes items that satisfy the provided filter function."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.p,{children:"The number of removed entries"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sweep"})}),"\n",(0,s.jsx)(n.h4,{id:"sweepfn-thisarg",children:"sweep(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sweep"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-34",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sweep"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tap",children:"tap()"}),"\n",(0,s.jsx)(n.h4,{id:"tapfn",children:"tap(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tap"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a function on the collection and returns the collection."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsx)(n.h5,{id:"returns-76",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"example-16",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection\n .tap(coll => console.log(coll.size))\n .filter(user => user.bot)\n .tap(coll => console.log(coll.size))\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.tap"})}),"\n",(0,s.jsx)(n.h4,{id:"tapfn-thisarg",children:"tap(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tap"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-35",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-77",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.tap"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tojson",children:"toJSON()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"toJSON"}),"(): ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.toJSON"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"values",children:"values()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"values"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of values in the map"}),"\n",(0,s.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.values"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"combineentries",children:"combineEntries()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"combineEntries"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"entries"}),", ",(0,s.jsx)(n.code,{children:"combine"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a Collection from a list of entries."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-36",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"entries"}),": ",(0,s.jsx)(n.code,{children:"Iterable"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.p,{children:"The list of entries"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"combine"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to combine an existing entry with a new one"}),"\n",(0,s.jsx)(n.h4,{id:"returns-80",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-17",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);\n// returns Collection { "a" => 3, "b" => 2 }\n'})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.combineEntries"})})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var s=r(6540);const i={},l=s.createContext(i);function d(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd96faf0.dc4808bc.js b/assets/js/fd96faf0.dc4808bc.js deleted file mode 100644 index 10ca78dabf..0000000000 --- a/assets/js/fd96faf0.dc4808bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4113],{877:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>a,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var s=r(4848),i=r(8453);const l={},d="Class: Collection",c={id:"reference/structures/Collector/classes/Collection",title:"Class: Collection\\",description:"Extends",source:"@site/docs/reference/structures/Collector/classes/Collection.md",sourceDirName:"reference/structures/Collector/classes",slug:"/reference/structures/Collector/classes/Collection",permalink:"/docs/reference/structures/Collector/classes/Collection",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/structures/Collector/classes/Collection.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"structures/Collector",permalink:"/docs/reference/structures/Collector/"},next:{title:"Class: Collector",permalink:"/docs/reference/structures/Collector/classes/Collector"}},h={},t=[{value:"Extends",id:"extends",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Collection()",id:"new-collection",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"new Collection()",id:"new-collection-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Properties",id:"properties",level:2},{value:"[toStringTag]",id:"tostringtag",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"constructor",id:"constructor",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"size",id:"size",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"[species]",id:"species",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Methods",id:"methods",level:2},{value:"[iterator]()",id:"iterator",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"at()",id:"at",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"clear()",id:"clear",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"clone()",id:"clone",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"concat()",id:"concat",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Example",id:"example-1",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"difference()",id:"difference",level:3},{value:"Type Parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"each()",id:"each",level:3},{value:"each(fn)",id:"eachfn",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Example",id:"example-2",level:5},{value:"Inherited from",id:"inherited-from-13",level:5},{value:"each(fn, thisArg)",id:"eachfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-2",level:5},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Inherited from",id:"inherited-from-14",level:5},{value:"ensure()",id:"ensure",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-3",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"entries()",id:"entries",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"equals()",id:"equals",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"every()",id:"every",level:3},{value:"every(fn)",id:"everyfn",level:4},{value:"Type Parameters",id:"type-parameters-3",level:5},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-14",level:5},{value:"Example",id:"example-4",level:5},{value:"Inherited from",id:"inherited-from-18",level:5},{value:"every(fn)",id:"everyfn-1",level:4},{value:"Type Parameters",id:"type-parameters-4",level:5},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-15",level:5},{value:"Inherited from",id:"inherited-from-19",level:5},{value:"every(fn)",id:"everyfn-2",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-16",level:5},{value:"Inherited from",id:"inherited-from-20",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-5",level:5},{value:"Parameters",id:"parameters-13",level:5},{value:"Returns",id:"returns-17",level:5},{value:"Inherited from",id:"inherited-from-21",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-6",level:5},{value:"Parameters",id:"parameters-14",level:5},{value:"Returns",id:"returns-18",level:5},{value:"Inherited from",id:"inherited-from-22",level:5},{value:"every(fn, thisArg)",id:"everyfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-7",level:5},{value:"Parameters",id:"parameters-15",level:5},{value:"Returns",id:"returns-19",level:5},{value:"Inherited from",id:"inherited-from-23",level:5},{value:"filter()",id:"filter",level:3},{value:"filter(fn)",id:"filterfn",level:4},{value:"Type Parameters",id:"type-parameters-8",level:5},{value:"Parameters",id:"parameters-16",level:5},{value:"Returns",id:"returns-20",level:5},{value:"Example",id:"example-5",level:5},{value:"Inherited from",id:"inherited-from-24",level:5},{value:"filter(fn)",id:"filterfn-1",level:4},{value:"Type Parameters",id:"type-parameters-9",level:5},{value:"Parameters",id:"parameters-17",level:5},{value:"Returns",id:"returns-21",level:5},{value:"Inherited from",id:"inherited-from-25",level:5},{value:"filter(fn)",id:"filterfn-2",level:4},{value:"Parameters",id:"parameters-18",level:5},{value:"Returns",id:"returns-22",level:5},{value:"Inherited from",id:"inherited-from-26",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-10",level:5},{value:"Parameters",id:"parameters-19",level:5},{value:"Returns",id:"returns-23",level:5},{value:"Inherited from",id:"inherited-from-27",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-11",level:5},{value:"Parameters",id:"parameters-20",level:5},{value:"Returns",id:"returns-24",level:5},{value:"Inherited from",id:"inherited-from-28",level:5},{value:"filter(fn, thisArg)",id:"filterfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-12",level:5},{value:"Parameters",id:"parameters-21",level:5},{value:"Returns",id:"returns-25",level:5},{value:"Inherited from",id:"inherited-from-29",level:5},{value:"find()",id:"find",level:3},{value:"find(fn)",id:"findfn",level:4},{value:"Type Parameters",id:"type-parameters-13",level:5},{value:"Parameters",id:"parameters-22",level:5},{value:"Returns",id:"returns-26",level:5},{value:"Example",id:"example-6",level:5},{value:"Inherited from",id:"inherited-from-30",level:5},{value:"find(fn)",id:"findfn-1",level:4},{value:"Parameters",id:"parameters-23",level:5},{value:"Returns",id:"returns-27",level:5},{value:"Inherited from",id:"inherited-from-31",level:5},{value:"find(fn, thisArg)",id:"findfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-14",level:5},{value:"Parameters",id:"parameters-24",level:5},{value:"Returns",id:"returns-28",level:5},{value:"Inherited from",id:"inherited-from-32",level:5},{value:"find(fn, thisArg)",id:"findfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-15",level:5},{value:"Parameters",id:"parameters-25",level:5},{value:"Returns",id:"returns-29",level:5},{value:"Inherited from",id:"inherited-from-33",level:5},{value:"findKey()",id:"findkey",level:3},{value:"findKey(fn)",id:"findkeyfn",level:4},{value:"Type Parameters",id:"type-parameters-16",level:5},{value:"Parameters",id:"parameters-26",level:5},{value:"Returns",id:"returns-30",level:5},{value:"Example",id:"example-7",level:5},{value:"Inherited from",id:"inherited-from-34",level:5},{value:"findKey(fn)",id:"findkeyfn-1",level:4},{value:"Parameters",id:"parameters-27",level:5},{value:"Returns",id:"returns-31",level:5},{value:"Inherited from",id:"inherited-from-35",level:5},{value:"findKey(fn, thisArg)",id:"findkeyfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-17",level:5},{value:"Parameters",id:"parameters-28",level:5},{value:"Returns",id:"returns-32",level:5},{value:"Inherited from",id:"inherited-from-36",level:5},{value:"findKey(fn, thisArg)",id:"findkeyfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-18",level:5},{value:"Parameters",id:"parameters-29",level:5},{value:"Returns",id:"returns-33",level:5},{value:"Inherited from",id:"inherited-from-37",level:5},{value:"first()",id:"first",level:3},{value:"first()",id:"first-1",level:4},{value:"Returns",id:"returns-34",level:5},{value:"Inherited from",id:"inherited-from-38",level:5},{value:"first(amount)",id:"firstamount",level:4},{value:"Parameters",id:"parameters-30",level:5},{value:"Returns",id:"returns-35",level:5},{value:"Inherited from",id:"inherited-from-39",level:5},{value:"firstKey()",id:"firstkey",level:3},{value:"firstKey()",id:"firstkey-1",level:4},{value:"Returns",id:"returns-36",level:5},{value:"Inherited from",id:"inherited-from-40",level:5},{value:"firstKey(amount)",id:"firstkeyamount",level:4},{value:"Parameters",id:"parameters-31",level:5},{value:"Returns",id:"returns-37",level:5},{value:"Inherited from",id:"inherited-from-41",level:5},{value:"flatMap()",id:"flatmap",level:3},{value:"flatMap(fn)",id:"flatmapfn",level:4},{value:"Type Parameters",id:"type-parameters-19",level:5},{value:"Parameters",id:"parameters-32",level:5},{value:"Returns",id:"returns-38",level:5},{value:"Example",id:"example-8",level:5},{value:"Inherited from",id:"inherited-from-42",level:5},{value:"flatMap(fn, thisArg)",id:"flatmapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-20",level:5},{value:"Parameters",id:"parameters-33",level:5},{value:"Returns",id:"returns-39",level:5},{value:"Inherited from",id:"inherited-from-43",level:5},{value:"forEach()",id:"foreach",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"hasAll()",id:"hasall",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Inherited from",id:"inherited-from-47",level:4},{value:"hasAny()",id:"hasany",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Inherited from",id:"inherited-from-48",level:4},{value:"intersect()",id:"intersect",level:3},{value:"Type Parameters",id:"type-parameters-21",level:4},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Inherited from",id:"inherited-from-49",level:4},{value:"keyAt()",id:"keyat",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Inherited from",id:"inherited-from-50",level:4},{value:"keys()",id:"keys",level:3},{value:"Returns",id:"returns-47",level:4},{value:"Inherited from",id:"inherited-from-51",level:4},{value:"last()",id:"last",level:3},{value:"last()",id:"last-1",level:4},{value:"Returns",id:"returns-48",level:5},{value:"Inherited from",id:"inherited-from-52",level:5},{value:"last(amount)",id:"lastamount",level:4},{value:"Parameters",id:"parameters-41",level:5},{value:"Returns",id:"returns-49",level:5},{value:"Inherited from",id:"inherited-from-53",level:5},{value:"lastKey()",id:"lastkey",level:3},{value:"lastKey()",id:"lastkey-1",level:4},{value:"Returns",id:"returns-50",level:5},{value:"Inherited from",id:"inherited-from-54",level:5},{value:"lastKey(amount)",id:"lastkeyamount",level:4},{value:"Parameters",id:"parameters-42",level:5},{value:"Returns",id:"returns-51",level:5},{value:"Inherited from",id:"inherited-from-55",level:5},{value:"map()",id:"map",level:3},{value:"map(fn)",id:"mapfn",level:4},{value:"Type Parameters",id:"type-parameters-22",level:5},{value:"Parameters",id:"parameters-43",level:5},{value:"Returns",id:"returns-52",level:5},{value:"Example",id:"example-9",level:5},{value:"Inherited from",id:"inherited-from-56",level:5},{value:"map(fn, thisArg)",id:"mapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-23",level:5},{value:"Parameters",id:"parameters-44",level:5},{value:"Returns",id:"returns-53",level:5},{value:"Inherited from",id:"inherited-from-57",level:5},{value:"mapValues()",id:"mapvalues",level:3},{value:"mapValues(fn)",id:"mapvaluesfn",level:4},{value:"Type Parameters",id:"type-parameters-24",level:5},{value:"Parameters",id:"parameters-45",level:5},{value:"Returns",id:"returns-54",level:5},{value:"Example",id:"example-10",level:5},{value:"Inherited from",id:"inherited-from-58",level:5},{value:"mapValues(fn, thisArg)",id:"mapvaluesfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-25",level:5},{value:"Parameters",id:"parameters-46",level:5},{value:"Returns",id:"returns-55",level:5},{value:"Inherited from",id:"inherited-from-59",level:5},{value:"merge()",id:"merge",level:3},{value:"Type Parameters",id:"type-parameters-26",level:4},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Examples",id:"examples",level:4},{value:"Inherited from",id:"inherited-from-60",level:4},{value:"partition()",id:"partition",level:3},{value:"partition(fn)",id:"partitionfn",level:4},{value:"Type Parameters",id:"type-parameters-27",level:5},{value:"Parameters",id:"parameters-48",level:5},{value:"Returns",id:"returns-57",level:5},{value:"Example",id:"example-11",level:5},{value:"Inherited from",id:"inherited-from-61",level:5},{value:"partition(fn)",id:"partitionfn-1",level:4},{value:"Type Parameters",id:"type-parameters-28",level:5},{value:"Parameters",id:"parameters-49",level:5},{value:"Returns",id:"returns-58",level:5},{value:"Inherited from",id:"inherited-from-62",level:5},{value:"partition(fn)",id:"partitionfn-2",level:4},{value:"Parameters",id:"parameters-50",level:5},{value:"Returns",id:"returns-59",level:5},{value:"Inherited from",id:"inherited-from-63",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-29",level:5},{value:"Parameters",id:"parameters-51",level:5},{value:"Returns",id:"returns-60",level:5},{value:"Inherited from",id:"inherited-from-64",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg-1",level:4},{value:"Type Parameters",id:"type-parameters-30",level:5},{value:"Parameters",id:"parameters-52",level:5},{value:"Returns",id:"returns-61",level:5},{value:"Inherited from",id:"inherited-from-65",level:5},{value:"partition(fn, thisArg)",id:"partitionfn-thisarg-2",level:4},{value:"Type Parameters",id:"type-parameters-31",level:5},{value:"Parameters",id:"parameters-53",level:5},{value:"Returns",id:"returns-62",level:5},{value:"Inherited from",id:"inherited-from-66",level:5},{value:"random()",id:"random",level:3},{value:"random()",id:"random-1",level:4},{value:"Returns",id:"returns-63",level:5},{value:"Inherited from",id:"inherited-from-67",level:5},{value:"random(amount)",id:"randomamount",level:4},{value:"Parameters",id:"parameters-54",level:5},{value:"Returns",id:"returns-64",level:5},{value:"Inherited from",id:"inherited-from-68",level:5},{value:"randomKey()",id:"randomkey",level:3},{value:"randomKey()",id:"randomkey-1",level:4},{value:"Returns",id:"returns-65",level:5},{value:"Inherited from",id:"inherited-from-69",level:5},{value:"randomKey(amount)",id:"randomkeyamount",level:4},{value:"Parameters",id:"parameters-55",level:5},{value:"Returns",id:"returns-66",level:5},{value:"Inherited from",id:"inherited-from-70",level:5},{value:"reduce()",id:"reduce",level:3},{value:"Type Parameters",id:"type-parameters-32",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-67",level:4},{value:"Example",id:"example-12",level:4},{value:"Inherited from",id:"inherited-from-71",level:4},{value:"reverse()",id:"reverse",level:3},{value:"Returns",id:"returns-68",level:4},{value:"Inherited from",id:"inherited-from-72",level:4},{value:"set()",id:"set",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-69",level:4},{value:"Inherited from",id:"inherited-from-73",level:4},{value:"some()",id:"some",level:3},{value:"some(fn)",id:"somefn",level:4},{value:"Parameters",id:"parameters-58",level:5},{value:"Returns",id:"returns-70",level:5},{value:"Example",id:"example-13",level:5},{value:"Inherited from",id:"inherited-from-74",level:5},{value:"some(fn, thisArg)",id:"somefn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-33",level:5},{value:"Parameters",id:"parameters-59",level:5},{value:"Returns",id:"returns-71",level:5},{value:"Inherited from",id:"inherited-from-75",level:5},{value:"sort()",id:"sort",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Example",id:"example-14",level:4},{value:"Inherited from",id:"inherited-from-76",level:4},{value:"sorted()",id:"sorted",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Example",id:"example-15",level:4},{value:"Inherited from",id:"inherited-from-77",level:4},{value:"sweep()",id:"sweep",level:3},{value:"sweep(fn)",id:"sweepfn",level:4},{value:"Parameters",id:"parameters-62",level:5},{value:"Returns",id:"returns-74",level:5},{value:"Inherited from",id:"inherited-from-78",level:5},{value:"sweep(fn, thisArg)",id:"sweepfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-34",level:5},{value:"Parameters",id:"parameters-63",level:5},{value:"Returns",id:"returns-75",level:5},{value:"Inherited from",id:"inherited-from-79",level:5},{value:"tap()",id:"tap",level:3},{value:"tap(fn)",id:"tapfn",level:4},{value:"Parameters",id:"parameters-64",level:5},{value:"Returns",id:"returns-76",level:5},{value:"Example",id:"example-16",level:5},{value:"Inherited from",id:"inherited-from-80",level:5},{value:"tap(fn, thisArg)",id:"tapfn-thisarg",level:4},{value:"Type Parameters",id:"type-parameters-35",level:5},{value:"Parameters",id:"parameters-65",level:5},{value:"Returns",id:"returns-77",level:5},{value:"Inherited from",id:"inherited-from-81",level:5},{value:"toJSON()",id:"tojson",level:3},{value:"Returns",id:"returns-78",level:4},{value:"Overrides",id:"overrides",level:4},{value:"values()",id:"values",level:3},{value:"Returns",id:"returns-79",level:4},{value:"Inherited from",id:"inherited-from-82",level:4},{value:"combineEntries()",id:"combineentries",level:3},{value:"Type Parameters",id:"type-parameters-36",level:4},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-80",level:4},{value:"Example",id:"example-17",level:4},{value:"Inherited from",id:"inherited-from-83",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"class-collectionk-v",children:"Class: Collection"}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V"})]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"new-collection",children:"new Collection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"entries"}),"?): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"entries?"}),": readonly readonly [",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"][]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.h3,{id:"new-collection-1",children:"new Collection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"new Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"iterable"}),"?): ",(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"iterable?"}),": ",(0,s.jsx)(n.code,{children:"Iterable"}),""]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,s.jsx)(n.code,{children:"Collection"})}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"tostringtag",children:"[toStringTag]"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"[toStringTag]"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[toStringTag]"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"constructor"}),": ",(0,s.jsx)(n.code,{children:"CollectionConstructor"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The initial value of Object.prototype.constructor is the standard built-in Object constructor."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.constructor"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.size"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"species",children:"[species]"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"[species]"}),": ",(0,s.jsx)(n.code,{children:"MapConstructor"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[species]"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"iterator",children:"[iterator]()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"[iterator]"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of entries in the map."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.[iterator]"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"at",children:"at()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"at"}),"(",(0,s.jsx)(n.code,{children:"index"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at",children:"Array.at()"}),".\nReturns the item at a given index, allowing for positive and negative integers.\nNegative integers count back from the last item in the collection."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"The index of the element to obtain"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.at"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clear",children:"clear()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clear"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.clear"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"clone",children:"clone()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"clone"}),"(): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates an identical shallow copy of this collection."}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const newColl = someColl.clone();\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.clone"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"concat",children:"concat()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"concat"}),"(...",(0,s.jsx)(n.code,{children:"collections"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Combines this collection with others into a new collection. None of the source collections are modified."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"collections"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">[]"]}),"\n",(0,s.jsx)(n.p,{children:"Collections to merge"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.concat"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"true if an element in the Map existed and has been removed, or false if the element does not exist."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.delete"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"difference",children:"difference()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"difference"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"other"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"})," | ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The difference method returns a new structure containing items where the key is present in one of the original structures but not the other."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to filter against"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"})," | ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.difference"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"each",children:"each()"}),"\n",(0,s.jsx)(n.h4,{id:"eachfn",children:"each(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"each"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach",children:"Map.forEach()"}),",\nbut returns the collection instead of undefined."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute for each element"}),"\n",(0,s.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection\n .each(user => console.log(user.username))\n .filter(user => user.bot)\n .each(user => console.log(user.username));\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.each"})}),"\n",(0,s.jsx)(n.h4,{id:"eachfn-thisarg",children:"each(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"each"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.each"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ensure",children:"ensure()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ensure"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"defaultValueGenerator"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to get if it exists, or set otherwise"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"defaultValueGenerator"})]}),"\n",(0,s.jsx)(n.p,{children:"A function that generates the default value"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.ensure(guildId, () => defaultGuildConfig);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.ensure"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entries",children:"entries()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"entries"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of key, value pairs for every entry in the map."}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.entries"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"equals",children:"equals()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"equals"}),"(",(0,s.jsx)(n.code,{children:"collection"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if this collection shares identical items with another.\nThis is different to checking for equality using equal-signs, because\nthe collections may be different objects, but contain the same data."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"collection"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Collection to compare with"}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"Whether the collections have identical contents"}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.equals"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"every",children:"every()"}),"\n",(0,s.jsx)(n.h4,{id:"everyfn",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Checks if all items passes a test. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every",children:"Array.every()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.every(user => !user.bot);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-1",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-2",children:"every(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg-1",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this is Collection"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this is Collection"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.h4,{id:"everyfn-thisarg-2",children:"every(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"every"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.every"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filter",children:"filter()"}),"\n",(0,s.jsx)(n.h4,{id:"filterfn",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter",children:"Array.filter()"}),",\nbut returns a Collection instead of an Array."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-8",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.filter(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-1",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-9",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-2",children:"filter(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-26",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-10",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-27",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg-1",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-11",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-28",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.h4,{id:"filterfn-thisarg-2",children:"filter(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"filter"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-12",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-29",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.filter"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"find",children:"find()"}),"\n",(0,s.jsx)(n.h4,{id:"findfn",children:"find(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"V2"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Searches for a single item where the given function returns a truthy value. This behaves like\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find",children:"Array.find()"}),".\n",(0,s.jsxs)("warn",{children:["All collections used in Discord.js are mapped using their ",(0,s.jsx)(n.code,{children:"id"})," property, and if you want to find by id you\nshould use the ",(0,s.jsx)(n.code,{children:"get"})," method. See\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get",children:"MDN"})," for details."]})]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-13",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V2"})}),"\n",(0,s.jsx)(n.h5,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.find(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-30",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-1",children:"find(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-31",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-thisarg",children:"find(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"V2"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-14",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V2"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-32",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.h4,{id:"findfn-thisarg-1",children:"find(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"find"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-15",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-33",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.find"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"findkey",children:"findKey()"}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn",children:"findKey(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"K2"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Searches for the key of a single item where the given function returns a truthy value. This behaves like\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex",children:"Array.findIndex()"}),",\nbut returns the key rather than the positional index."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-16",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"The function to test with (should return boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K2"})}),"\n",(0,s.jsx)(n.h5,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.findKey(user => user.username === 'Bob');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-34",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-1",children:"findKey(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-35",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-thisarg",children:"findKey(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"K2"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-17",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K2"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-36",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.h4,{id:"findkeyfn-thisarg-1",children:"findKey(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"findKey"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-18",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-37",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.findKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"first",children:"first()"}),"\n",(0,s.jsx)(n.h4,{id:"first-1",children:"first()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"first"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the first value(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values, starting from the end if amount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-38",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.first"})}),"\n",(0,s.jsx)(n.h4,{id:"firstamount",children:"first(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"first"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-39",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.first"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"firstkey",children:"firstKey()"}),"\n",(0,s.jsx)(n.h4,{id:"firstkey-1",children:"firstKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"firstKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the first key(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array of keys, starting from the end if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-40",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.firstKey"})}),"\n",(0,s.jsx)(n.h4,{id:"firstkeyamount",children:"firstKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"firstKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-41",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.firstKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"flatmap",children:"flatMap()"}),"\n",(0,s.jsx)(n.h4,{id:"flatmapfn",children:"flatMap(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"flatMap"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap",children:"Array.flatMap()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-19",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces a new Collection"}),"\n",(0,s.jsx)(n.h5,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.flatMap(guild => guild.members.cache);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-42",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.flatMap"})}),"\n",(0,s.jsx)(n.h4,{id:"flatmapfn-thisarg",children:"flatMap(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"flatMap"}),"<",(0,s.jsx)(n.code,{children:"T"}),", ",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-20",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-43",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.flatMap"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"foreach",children:"forEach()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"forEach"}),"(",(0,s.jsx)(n.code,{children:"callbackfn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Executes a provided function once per each key/value pair in the Map, in insertion order."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"callbackfn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-40",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-44",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.forEach"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-41",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-45",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.get"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"has"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-42",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"boolean indicating whether an element with the specified key exists or not."}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-46",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.has"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasall",children:"hasAll()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hasAll"}),"(...",(0,s.jsx)(n.code,{children:"keys"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if all of the elements exist in the collection."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"keys"}),": ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The keys of the elements to check for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-43",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if all of the elements exist, ",(0,s.jsx)(n.code,{children:"false"})," if at least one does not exist."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-47",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.hasAll"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasany",children:"hasAny()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hasAny"}),"(...",(0,s.jsx)(n.code,{children:"keys"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Checks if any of the elements exist in the collection."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"keys"}),": ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The keys of the elements to check for"}),"\n",(0,s.jsx)(n.h4,{id:"returns-44",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if any of the elements exist, ",(0,s.jsx)(n.code,{children:"false"})," if none exist."]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-48",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.hasAny"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"intersect",children:"intersect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"intersect"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"other"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The intersect method returns a new structure containing items where the keys and values are present in both original structures."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-21",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to filter against"}),"\n",(0,s.jsx)(n.h4,{id:"returns-45",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-49",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.intersect"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"keyat",children:"keyAt()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"keyAt"}),"(",(0,s.jsx)(n.code,{children:"index"}),"): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at",children:"Array.at()"}),".\nReturns the key at a given index, allowing for positive and negative integers.\nNegative integers count back from the last item in the collection."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"The index of the key to obtain"}),"\n",(0,s.jsx)(n.h4,{id:"returns-46",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-50",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.keyAt"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"keys",children:"keys()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"keys"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"K"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of keys in the map"}),"\n",(0,s.jsx)(n.h4,{id:"returns-47",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"K"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-51",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.keys"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last()"}),"\n",(0,s.jsx)(n.h4,{id:"last-1",children:"last()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"last"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the last value(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-48",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values, starting from the start if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-52",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.last"})}),"\n",(0,s.jsx)(n.h4,{id:"lastamount",children:"last(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"last"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-41",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-49",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-53",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.last"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"lastkey",children:"lastKey()"}),"\n",(0,s.jsx)(n.h4,{id:"lastkey-1",children:"lastKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lastKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains the last key(s) in this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-50",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array of keys, starting from the start if\namount is negative"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-54",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.lastKey"})}),"\n",(0,s.jsx)(n.h4,{id:"lastkeyamount",children:"lastKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lastKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-42",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-51",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-55",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.lastKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"map",children:"map()"}),"\n",(0,s.jsx)(n.h4,{id:"mapfn",children:"map(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"map"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item to another value into an array. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map",children:"Array.map()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-22",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-43",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces an element of the new array, taking three arguments"}),"\n",(0,s.jsx)(n.h5,{id:"returns-52",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.map(user => user.tag);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-56",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.map"})}),"\n",(0,s.jsx)(n.h4,{id:"mapfn-thisarg",children:"map(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"map"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-23",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-44",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-53",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-57",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.map"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mapvalues",children:"mapValues()"}),"\n",(0,s.jsx)(n.h4,{id:"mapvaluesfn",children:"mapValues(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapValues"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Maps each item to another value into a collection. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map",children:"Array.map()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-24",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-45",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function that produces an element of the new collection, taking three arguments"}),"\n",(0,s.jsx)(n.h5,{id:"returns-54",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.mapValues(user => user.tag);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-58",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.mapValues"})}),"\n",(0,s.jsx)(n.h4,{id:"mapvaluesfn-thisarg",children:"mapValues(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapValues"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-25",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-46",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-55",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-59",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.mapValues"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"merge",children:"merge()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"merge"}),"<",(0,s.jsx)(n.code,{children:"T"}),", ",(0,s.jsx)(n.code,{children:"R"}),">(",(0,s.jsx)(n.code,{children:"other"}),", ",(0,s.jsx)(n.code,{children:"whenInSelf"}),", ",(0,s.jsx)(n.code,{children:"whenInOther"}),", ",(0,s.jsx)(n.code,{children:"whenInBoth"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Merges two Collections together into a new Collection."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-26",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"R"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"other"}),": ",(0,s.jsx)(n.code,{children:"ReadonlyCollection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The other Collection to merge with"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInSelf"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry only exists in this Collection"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInOther"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry only exists in the other Collection"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"whenInBoth"})]}),"\n",(0,s.jsx)(n.p,{children:"Function getting the result if the entry exists in both Collections"}),"\n",(0,s.jsx)(n.h4,{id:"returns-56",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// Sums up the entries in two collections.\ncoll.merge(\n other,\n x => ({ keep: true, value: x }),\n y => ({ keep: true, value: y }),\n (x, y) => ({ keep: true, value: x + y }),\n);\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// Intersects two collections in a left-biased manner.\ncoll.merge(\n other,\n x => ({ keep: false }),\n y => ({ keep: false }),\n (x, _) => ({ keep: true, value: x }),\n);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-60",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.merge"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"partition",children:"partition()"}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Partitions the collection into two collections where the first collection\ncontains the items that passed and the second contains the items that failed."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-27",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-48",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-57",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const [big, small] = collection.partition(guild => guild.memberCount > 250);\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-61",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-1",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-28",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-49",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-58",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-62",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-2",children:"partition(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-50",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-59",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-63",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-29",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-51",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-60",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K2"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"K2"}),">, ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-64",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg-1",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-30",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V2"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-52",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-61",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"Exclude"}),"<",(0,s.jsx)(n.code,{children:"V"}),", ",(0,s.jsx)(n.code,{children:"V2"}),">>]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-65",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.h4,{id:"partitionfn-thisarg-2",children:"partition(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"partition"}),"<",(0,s.jsx)(n.code,{children:"This"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): [",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-31",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-53",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"This"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-62",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">, ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-66",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.partition"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"random",children:"random()"}),"\n",(0,s.jsx)(n.h4,{id:"random-1",children:"random()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"random"}),"(): ",(0,s.jsx)(n.code,{children:"V"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains unique random value(s) from this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-63",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"V"})}),"\n",(0,s.jsx)(n.p,{children:"A single value if no amount is provided or an array of values"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-67",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.random"})}),"\n",(0,s.jsx)(n.h4,{id:"randomamount",children:"random(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"random"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-54",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-64",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-68",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.random"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"randomkey",children:"randomKey()"}),"\n",(0,s.jsx)(n.h4,{id:"randomkey-1",children:"randomKey()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"randomKey"}),"(): ",(0,s.jsx)(n.code,{children:"K"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Obtains unique random key(s) from this collection."}),"\n",(0,s.jsx)(n.h5,{id:"returns-65",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"K"})}),"\n",(0,s.jsx)(n.p,{children:"A single key if no amount is provided or an array"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-69",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.randomKey"})}),"\n",(0,s.jsx)(n.h4,{id:"randomkeyamount",children:"randomKey(amount)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"randomKey"}),"(",(0,s.jsx)(n.code,{children:"amount"}),"): ",(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-55",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"amount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-66",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"K"}),"[]"]}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-70",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.randomKey"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reduce",children:"reduce()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reduce"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"initialValue"}),"?): ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Applies a function to produce a single value. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce",children:"Array.reduce()"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-32",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["Function used to reduce, taking four arguments; ",(0,s.jsx)(n.code,{children:"accumulator"}),", ",(0,s.jsx)(n.code,{children:"currentValue"}),", ",(0,s.jsx)(n.code,{children:"currentKey"}),",\nand ",(0,s.jsx)(n.code,{children:"collection"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"initialValue?"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.p,{children:"Starting value for the accumulator"}),"\n",(0,s.jsx)(n.h4,{id:"returns-67",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"T"})}),"\n",(0,s.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.reduce((acc, guild) => acc + guild.memberCount, 0);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-71",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.reduce"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reverse",children:"reverse()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reverse"}),"(): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Identical to ",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse",children:"Array.reverse()"}),"\nbut returns a Collection instead of an Array."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-68",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-72",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.reverse"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"set",children:"set()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"set"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"V"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-69",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-73",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.set"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"some",children:"some()"}),"\n",(0,s.jsx)(n.h4,{id:"somefn",children:"some(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"some"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Checks if there exists an item that passes a test. Identical in behavior to\n",(0,s.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some",children:"Array.some()"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-58",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-70",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"example-13",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.some(user => user.discriminator === '0000');\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-74",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.some"})}),"\n",(0,s.jsx)(n.h4,{id:"somefn-thisarg",children:"some(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"some"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-33",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-59",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-71",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-75",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.some"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sort",children:"sort()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sort"}),"(",(0,s.jsx)(n.code,{children:"compareFunction"}),"?): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sort method sorts the items of a collection in place and returns it.\nThe sort is not necessarily stable in Node 10 or older.\nThe default sort order is according to string Unicode code points."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"compareFunction?"}),": ",(0,s.jsx)(n.code,{children:"Comparator"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a function that defines the sort order.\nIf omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element."}),"\n",(0,s.jsx)(n.h4,{id:"returns-72",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h4,{id:"example-14",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-76",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sort"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sorted",children:"sorted()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sorted"}),"(",(0,s.jsx)(n.code,{children:"compareFunction"}),"?): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The sorted method sorts the items of a collection and returns it.\nThe sort is not necessarily stable in Node 10 or older.\nThe default sort order is according to string Unicode code points."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"compareFunction?"}),": ",(0,s.jsx)(n.code,{children:"Comparator"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a function that defines the sort order.\nIf omitted, the collection is sorted according to each character's Unicode code point value,\naccording to the string conversion of each element."}),"\n",(0,s.jsx)(n.h4,{id:"returns-73",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-15",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-77",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sorted"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sweep",children:"sweep()"}),"\n",(0,s.jsx)(n.h4,{id:"sweepfn",children:"sweep(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sweep"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Removes items that satisfy the provided filter function."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-62",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function used to test (should return a boolean)"}),"\n",(0,s.jsx)(n.h5,{id:"returns-74",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.p,{children:"The number of removed entries"}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-78",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sweep"})}),"\n",(0,s.jsx)(n.h4,{id:"sweepfn-thisarg",children:"sweep(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sweep"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-34",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-63",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-75",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"number"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-79",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.sweep"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tap",children:"tap()"}),"\n",(0,s.jsx)(n.h4,{id:"tapfn",children:"tap(fn)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tap"}),"(",(0,s.jsx)(n.code,{children:"fn"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a function on the collection and returns the collection."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-64",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to execute"}),"\n",(0,s.jsx)(n.h5,{id:"returns-76",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"example-16",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"collection\n .tap(coll => console.log(coll.size))\n .filter(user => user.bot)\n .tap(coll => console.log(coll.size))\n"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-80",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.tap"})}),"\n",(0,s.jsx)(n.h4,{id:"tapfn-thisarg",children:"tap(fn, thisArg)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tap"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"fn"}),", ",(0,s.jsx)(n.code,{children:"thisArg"}),"): ",(0,s.jsx)(n.code,{children:"this"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-35",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters-65",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"fn"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArg"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"returns-77",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"this"})}),"\n",(0,s.jsx)(n.h5,{id:"inherited-from-81",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.tap"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tojson",children:"toJSON()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"toJSON"}),"(): ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-78",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.toJSON"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"values",children:"values()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"values"}),"(): ",(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns an iterable of values in the map"}),"\n",(0,s.jsx)(n.h4,{id:"returns-79",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IterableIterator"}),"<",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-82",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.values"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"combineentries",children:"combineEntries()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"static"})," ",(0,s.jsx)(n.strong,{children:"combineEntries"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">(",(0,s.jsx)(n.code,{children:"entries"}),", ",(0,s.jsx)(n.code,{children:"combine"}),"): ",(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a Collection from a list of entries."}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-36",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"K"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"V"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"entries"}),": ",(0,s.jsx)(n.code,{children:"Iterable"}),"<[",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),"]>"]}),"\n",(0,s.jsx)(n.p,{children:"The list of entries"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"combine"})]}),"\n",(0,s.jsx)(n.p,{children:"Function to combine an existing entry with a new one"}),"\n",(0,s.jsx)(n.h4,{id:"returns-80",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Collection"}),"<",(0,s.jsx)(n.code,{children:"K"}),", ",(0,s.jsx)(n.code,{children:"V"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-17",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);\n// returns Collection { "a" => 3, "b" => 2 }\n'})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-83",children:"Inherited from"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"BaseCollection.combineEntries"})})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var s=r(6540);const i={},l=s.createContext(i);function d(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ffc4ade8.8358a9a7.js b/assets/js/ffc4ade8.8358a9a7.js deleted file mode 100644 index 73d5ec31d8..0000000000 --- a/assets/js/ffc4ade8.8358a9a7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9094],{9100:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var t=n(4848),o=n(8453);const s={},i="Enumeration: AddParticipantErrorStatusCode",d={id:"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",title:"Enumeration: AddParticipantErrorStatusCode",description:"Add Participants Status Code Enum",source:"@site/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",sourceDirName:"reference/api/model/errors/enumerations",slug:"/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError"},next:{title:"Enumeration: ERROR\\_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME"}},a={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ALREADY_IN_GROUP",id:"already_in_group",level:3},{value:"GROUP_FULL",id:"group_full",level:3},{value:"PRIVACY_SETTINGS",id:"privacy_settings",level:3},{value:"RECENTLY_LEFT",id:"recently_left",level:3}];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"enumeration-addparticipanterrorstatuscode",children:"Enumeration: AddParticipantErrorStatusCode"}),"\n",(0,t.jsx)(r.p,{children:"Add Participants Status Code Enum"}),"\n",(0,t.jsx)(r.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(r.h3,{id:"already_in_group",children:"ALREADY_IN_GROUP"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ALREADY_IN_GROUP"}),": ",(0,t.jsx)(r.code,{children:"409"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because they are already in the group"}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"group_full",children:"GROUP_FULL"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"GROUP_FULL"}),": ",(0,t.jsx)(r.code,{children:"500"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because the group is full"}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"privacy_settings",children:"PRIVACY_SETTINGS"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"PRIVACY_SETTINGS"}),": ",(0,t.jsx)(r.code,{children:"403"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because their privacy settings do not allow you to add them."}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"recently_left",children:"RECENTLY_LEFT"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"RECENTLY_LEFT"}),": ",(0,t.jsx)(r.code,{children:"408"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because they recently left."})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>d});var t=n(6540);const o={},s=t.createContext(o);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ffc4ade8.df3ec751.js b/assets/js/ffc4ade8.df3ec751.js new file mode 100644 index 0000000000..bf8a4a6409 --- /dev/null +++ b/assets/js/ffc4ade8.df3ec751.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9094],{9100:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var t=n(4848),o=n(8453);const s={},i="Enumeration: AddParticipantErrorStatusCode",d={id:"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",title:"Enumeration: AddParticipantErrorStatusCode",description:"Add Participants Status Code Enum",source:"@site/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",sourceDirName:"reference/api/model/errors/enumerations",slug:"/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",permalink:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Class: SessionExpiredError",permalink:"/docs/reference/api/model/errors/classes/SessionExpiredError"},next:{title:"Enumeration: ERROR\\_NAME",permalink:"/docs/reference/api/model/errors/enumerations/ERROR_NAME"}},a={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"ALREADY_IN_GROUP",id:"already_in_group",level:3},{value:"GROUP_FULL",id:"group_full",level:3},{value:"PRIVACY_SETTINGS",id:"privacy_settings",level:3},{value:"RECENTLY_LEFT",id:"recently_left",level:3}];function l(e){const r={blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"enumeration-addparticipanterrorstatuscode",children:"Enumeration: AddParticipantErrorStatusCode"})}),"\n",(0,t.jsx)(r.p,{children:"Add Participants Status Code Enum"}),"\n",(0,t.jsx)(r.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(r.h3,{id:"already_in_group",children:"ALREADY_IN_GROUP"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ALREADY_IN_GROUP"}),": ",(0,t.jsx)(r.code,{children:"409"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because they are already in the group"}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"group_full",children:"GROUP_FULL"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"GROUP_FULL"}),": ",(0,t.jsx)(r.code,{children:"500"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because the group is full"}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"privacy_settings",children:"PRIVACY_SETTINGS"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"PRIVACY_SETTINGS"}),": ",(0,t.jsx)(r.code,{children:"403"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because their privacy settings do not allow you to add them."}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"recently_left",children:"RECENTLY_LEFT"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"RECENTLY_LEFT"}),": ",(0,t.jsx)(r.code,{children:"408"})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Participant could not be added to group because they recently left."})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>d});var t=n(6540);const o={},s=t.createContext(o);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.0d79d01b.js b/assets/js/main.0d79d01b.js new file mode 100644 index 0000000000..2a99ebc83d --- /dev/null +++ b/assets/js/main.0d79d01b.js @@ -0,0 +1,2 @@ +/*! For license information please see main.0d79d01b.js.LICENSE.txt */ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8792],{3219:(e,t,n)=>{"use strict";n.d(t,{Bc:()=>g,E8:()=>qn,a1:()=>$n});var r=n(6540);n(961);function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function c(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,o,a=[],i=!0,s=!1;try{for(n=n.call(e);!(i=(r=n.next()).done)&&(a.push(r.value),!t||a.length!==t);i=!0);}catch(e){s=!0,o=e}finally{try{i||null==n.return||n.return()}finally{if(s)throw o}}return a}}(e,t)||d(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function u(e){return function(e){if(Array.isArray(e))return p(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||d(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function d(e,t){if(e){if("string"==typeof e)return p(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?p(e,t):void 0}}function p(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);ne.length)&&(t=e.length);for(var n=0,r=new Array(t);ne.length)&&(t=e.length);for(var n=0,r=new Array(t);n=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function D(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function L(e){for(var t=1;t=3||2===n&&r>=4||1===n&&r>=10);function a(t,n,r){if(o&&void 0!==r){var a=r[0].__autocomplete_algoliaCredentials,i={"X-Algolia-Application-Id":a.appId,"X-Algolia-API-Key":a.apiKey};e.apply(void 0,[t].concat(j(n),[{headers:i}]))}else e.apply(void 0,[t].concat(j(n)))}return{init:function(t,n){e("init",{appId:t,apiKey:n})},setUserToken:function(t){e("setUserToken",t)},clickedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("clickedObjectIDsAfterSearch",M(t),t[0].items)},clickedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("clickedObjectIDs",M(t),t[0].items)},clickedFilters:function(){for(var t=arguments.length,n=new Array(t),r=0;r0&&e.apply(void 0,["clickedFilters"].concat(n))},convertedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("convertedObjectIDsAfterSearch",M(t),t[0].items)},convertedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("convertedObjectIDs",M(t),t[0].items)},convertedFilters:function(){for(var t=arguments.length,n=new Array(t),r=0;r0&&e.apply(void 0,["convertedFilters"].concat(n))},viewedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&t.reduce((function(e,t){var n=t.items,r=I(t,T);return[].concat(j(e),j(function(e){for(var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:20,n=[],r=0;r0&&e.apply(void 0,["viewedFilters"].concat(n))}}}function B(e){var t=e.items.reduce((function(e,t){var n;return e[t.__autocomplete_indexName]=(null!==(n=e[t.__autocomplete_indexName])&&void 0!==n?n:[]).concat(t),e}),{});return Object.keys(t).map((function(e){return{index:e,items:t[e],algoliaSource:["autocomplete"]}}))}function z(e){return e.objectID&&e.__autocomplete_indexName&&e.__autocomplete_queryID}function U(e){return U="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},U(e)}function $(e){return function(e){if(Array.isArray(e))return q(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(e){if("string"==typeof e)return q(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?q(e,t):void 0}}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function q(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n0&&K({onItemsChange:r,items:n,insights:s,state:t}))}}),0);return{name:"aa.algoliaInsightsPlugin",subscribe:function(e){var t=e.setContext,n=e.onSelect,r=e.onActive;i("addAlgoliaAgent","insights-plugin"),t({algoliaInsightsPlugin:{__algoliaSearchParameters:{clickAnalytics:!0},insights:s}}),n((function(e){var t=e.item,n=e.state,r=e.event;z(t)&&o({state:n,event:r,insights:s,item:t,insightsEvents:[G({eventName:"Item Selected"},C({item:t,items:l.current}))]})})),r((function(e){var t=e.item,n=e.state,r=e.event;z(t)&&a({state:n,event:r,insights:s,item:t,insightsEvents:[G({eventName:"Item Active"},C({item:t,items:l.current}))]})}))},onStateChange:function(e){var t=e.state;c({state:t})},__autocomplete_pluginOptions:e}}function Y(e,t){var n=t;return{then:function(t,r){return Y(e.then(J(t,n,e),J(r,n,e)),n)},catch:function(t){return Y(e.catch(J(t,n,e)),n)},finally:function(t){return t&&n.onCancelList.push(t),Y(e.finally(J(t&&function(){return n.onCancelList=[],t()},n,e)),n)},cancel:function(){n.isCanceled=!0;var e=n.onCancelList;n.onCancelList=[],e.forEach((function(e){e()}))},isCanceled:function(){return!0===n.isCanceled}}}function Z(e){return Y(e,{isCanceled:!1,onCancelList:[]})}function J(e,t,n){return e?function(n){return t.isCanceled?n:e(n)}:n}function X(e,t,n,r){if(!n)return null;if(e<0&&(null===t||null!==r&&0===t))return n+e;var o=(null===t?-1:t)+e;return o<=-1||o>=n?null===r?null:0:o}function ee(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function te(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n0},reshape:function(e){return e.sources}},e),{},{id:null!==(n=e.id)&&void 0!==n?n:"autocomplete-".concat(w++),plugins:o,initialState:ge({activeItemId:null,query:"",completion:null,collections:[],isOpen:!1,status:"idle",context:{}},e.initialState),onStateChange:function(t){var n;null===(n=e.onStateChange)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onStateChange)||void 0===n?void 0:n.call(e,t)}))},onSubmit:function(t){var n;null===(n=e.onSubmit)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onSubmit)||void 0===n?void 0:n.call(e,t)}))},onReset:function(t){var n;null===(n=e.onReset)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onReset)||void 0===n?void 0:n.call(e,t)}))},getSources:function(n){return Promise.all([].concat(function(e){return function(e){if(Array.isArray(e))return me(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(e){if("string"==typeof e)return me(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?me(e,t):void 0}}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}(o.map((function(e){return e.getSources}))),[e.getSources]).filter(Boolean).map((function(e){return function(e,t){var n=[];return Promise.resolve(e(t)).then((function(e){return Promise.all(e.filter((function(e){return Boolean(e)})).map((function(e){if(e.sourceId,n.includes(e.sourceId))throw new Error("[Autocomplete] The `sourceId` ".concat(JSON.stringify(e.sourceId)," is not unique."));n.push(e.sourceId);var t={getItemInputValue:function(e){return e.state.query},getItemUrl:function(){},onSelect:function(e){(0,e.setIsOpen)(!1)},onActive:_,onResolve:_};Object.keys(t).forEach((function(e){t[e].__default=!0}));var r=te(te({},t),e);return Promise.resolve(r)})))}))}(e,n)}))).then((function(e){return v(e)})).then((function(e){return e.map((function(e){return ge(ge({},e),{},{onSelect:function(n){e.onSelect(n),t.forEach((function(e){var t;return null===(t=e.onSelect)||void 0===t?void 0:t.call(e,n)}))},onActive:function(n){e.onActive(n),t.forEach((function(e){var t;return null===(t=e.onActive)||void 0===t?void 0:t.call(e,n)}))},onResolve:function(n){e.onResolve(n),t.forEach((function(e){var t;return null===(t=e.onResolve)||void 0===t?void 0:t.call(e,n)}))}})}))}))},navigator:ge({navigate:function(e){var t=e.itemUrl;r.location.assign(t)},navigateNewTab:function(e){var t=e.itemUrl,n=r.open(t,"_blank","noopener");null==n||n.focus()},navigateNewWindow:function(e){var t=e.itemUrl;r.open(t,"_blank","noopener")}},e.navigator)})}function ve(e){return ve="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},ve(e)}function we(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function Se(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}(e,Re);Be&&o.environment.clearTimeout(Be);var c=l.setCollections,u=l.setIsOpen,d=l.setQuery,p=l.setActiveItemId,f=l.setStatus;if(d(a),p(o.defaultActiveItemId),!a&&!1===o.openOnFocus){var m,h=s.getState().collections.map((function(e){return De(De({},e),{},{items:[]})}));f("idle"),c(h),u(null!==(m=r.isOpen)&&void 0!==m?m:o.shouldPanelOpen({state:s.getState()}));var g=Z(ze(h).then((function(){return Promise.resolve()})));return s.pendingRequests.add(g)}f("loading"),Be=o.environment.setTimeout((function(){f("stalled")}),o.stallThreshold);var b=Z(ze(o.getSources(De({query:a,refresh:i,state:s.getState()},l)).then((function(e){return Promise.all(e.map((function(e){return Promise.resolve(e.getItems(De({query:a,refresh:i,state:s.getState()},l))).then((function(t){return function(e,t,n){if(o=e,Boolean(null==o?void 0:o.execute)){var r="algolia"===e.requesterId?Object.assign.apply(Object,[{}].concat(Oe(Object.keys(n.context).map((function(e){var t;return null===(t=n.context[e])||void 0===t?void 0:t.__algoliaSearchParameters}))))):{};return Ee(Ee({},e),{},{requests:e.queries.map((function(n){return{query:"algolia"===e.requesterId?Ee(Ee({},n),{},{params:Ee(Ee({},r),n.params)}):n,sourceId:t,transformResponse:e.transformResponse}}))})}var o;return{items:e,sourceId:t}}(t,e.sourceId,s.getState())}))}))).then(Ae).then((function(t){return function(e,t,n){return t.map((function(t){var r,o=e.filter((function(e){return e.sourceId===t.sourceId})),a=o.map((function(e){return e.items})),i=o[0].transformResponse,s=i?i({results:r=a,hits:r.map((function(e){return e.hits})).filter(Boolean),facetHits:r.map((function(e){var t;return null===(t=e.facetHits)||void 0===t?void 0:t.map((function(e){return{label:e.value,count:e.count,_highlightResult:{label:{value:e.highlighted}}}}))})).filter(Boolean)}):a;return t.onResolve({source:t,results:a,items:s,state:n.getState()}),s.every(Boolean),'The `getItems` function from source "'.concat(t.sourceId,'" must return an array of items but returned ').concat(JSON.stringify(void 0),".\n\nDid you forget to return items?\n\nSee: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-getitems"),{source:t,items:s}}))}(t,e,s)})).then((function(e){return function(e){var t=e.props,n=e.state,r=e.collections.reduce((function(e,t){return Se(Se({},e),{},ke({},t.source.sourceId,Se(Se({},t.source),{},{getItems:function(){return v(t.items)}})))}),{}),o=t.plugins.reduce((function(e,t){return t.reshape?t.reshape(e):e}),{sourcesBySourceId:r,state:n}).sourcesBySourceId;return v(t.reshape({sourcesBySourceId:o,sources:Object.values(o),state:n})).filter(Boolean).map((function(e){return{source:e,items:e.getItems()}}))}({collections:e,props:o,state:s.getState()})}))})))).then((function(e){var n;f("idle"),c(e);var d=o.shouldPanelOpen({state:s.getState()});u(null!==(n=r.isOpen)&&void 0!==n?n:o.openOnFocus&&!a&&d||d);var p=oe(s.getState());if(null!==s.getState().activeItemId&&p){var m=p.item,h=p.itemInputValue,g=p.itemUrl,b=p.source;b.onActive(De({event:t,item:m,itemInputValue:h,itemUrl:g,refresh:i,source:b,state:s.getState()},l))}})).finally((function(){f("idle"),Be&&o.environment.clearTimeout(Be)}));return s.pendingRequests.add(b)}function $e(e){return $e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},$e(e)}var qe=["event","props","refresh","store"];function He(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function Ge(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function at(e){var t=e.props,n=e.refresh,r=e.store,o=ot(e,Ke),a=function(e,t){return void 0!==t?"".concat(e,"-").concat(t):e};return{getEnvironmentProps:function(e){var n=e.inputElement,o=e.formElement,a=e.panelElement;function i(e){!r.getState().isOpen&&r.pendingRequests.isEmpty()||e.target===n||!1===[o,a].some((function(t){return(n=t)===(r=e.target)||n.contains(r);var n,r}))&&(r.dispatch("blur",null),t.debug||r.pendingRequests.cancelAll())}return nt({onTouchStart:i,onMouseDown:i,onTouchMove:function(e){!1!==r.getState().isOpen&&n===t.environment.document.activeElement&&e.target!==n&&n.blur()}},ot(e,Qe))},getRootProps:function(e){return nt({role:"combobox","aria-expanded":r.getState().isOpen,"aria-haspopup":"listbox","aria-owns":r.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label")},e)},getFormProps:function(e){return e.inputElement,nt({action:"",noValidate:!0,role:"search",onSubmit:function(a){var i;a.preventDefault(),t.onSubmit(nt({event:a,refresh:n,state:r.getState()},o)),r.dispatch("submit",null),null===(i=e.inputElement)||void 0===i||i.blur()},onReset:function(a){var i;a.preventDefault(),t.onReset(nt({event:a,refresh:n,state:r.getState()},o)),r.dispatch("reset",null),null===(i=e.inputElement)||void 0===i||i.focus()}},ot(e,Ye))},getLabelProps:function(e){var n=e||{},r=n.sourceIndex,o=ot(n,Je);return nt({htmlFor:"".concat(a(t.id,r),"-input"),id:"".concat(a(t.id,r),"-label")},o)},getInputProps:function(e){var a;function i(e){(t.openOnFocus||Boolean(r.getState().query))&&Ue(nt({event:e,props:t,query:r.getState().completion||r.getState().query,refresh:n,store:r},o)),r.dispatch("focus",null)}var s=e||{},l=(s.inputElement,s.maxLength),c=void 0===l?512:l,u=ot(s,Ze),d=oe(r.getState()),p=function(e){return Boolean(e&&e.match(ae))}((null===(a=t.environment.navigator)||void 0===a?void 0:a.userAgent)||""),f=null!=d&&d.itemUrl&&!p?"go":"search";return nt({"aria-autocomplete":"both","aria-activedescendant":r.getState().isOpen&&null!==r.getState().activeItemId?"".concat(t.id,"-item-").concat(r.getState().activeItemId):void 0,"aria-controls":r.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label"),value:r.getState().completion||r.getState().query,id:"".concat(t.id,"-input"),autoComplete:"off",autoCorrect:"off",autoCapitalize:"off",enterKeyHint:f,spellCheck:"false",autoFocus:t.autoFocus,placeholder:t.placeholder,maxLength:c,type:"search",onChange:function(e){Ue(nt({event:e,props:t,query:e.currentTarget.value.slice(0,c),refresh:n,store:r},o))},onKeyDown:function(e){!function(e){var t=e.event,n=e.props,r=e.refresh,o=e.store,a=function(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},a=Object.keys(e);for(r=0;r=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}(e,qe);if("ArrowUp"===t.key||"ArrowDown"===t.key){var i=function(){var e=n.environment.document.getElementById("".concat(n.id,"-item-").concat(o.getState().activeItemId));e&&(e.scrollIntoViewIfNeeded?e.scrollIntoViewIfNeeded(!1):e.scrollIntoView(!1))},s=function(){var e=oe(o.getState());if(null!==o.getState().activeItemId&&e){var n=e.item,i=e.itemInputValue,s=e.itemUrl,l=e.source;l.onActive(Ge({event:t,item:n,itemInputValue:i,itemUrl:s,refresh:r,source:l,state:o.getState()},a))}};t.preventDefault(),!1===o.getState().isOpen&&(n.openOnFocus||Boolean(o.getState().query))?Ue(Ge({event:t,props:n,query:o.getState().query,refresh:r,store:o},a)).then((function(){o.dispatch(t.key,{nextActiveItemId:n.defaultActiveItemId}),s(),setTimeout(i,0)})):(o.dispatch(t.key,{}),s(),i())}else if("Escape"===t.key)t.preventDefault(),o.dispatch(t.key,null),o.pendingRequests.cancelAll();else if("Tab"===t.key)o.dispatch("blur",null),o.pendingRequests.cancelAll();else if("Enter"===t.key){if(null===o.getState().activeItemId||o.getState().collections.every((function(e){return 0===e.items.length})))return void(n.debug||o.pendingRequests.cancelAll());t.preventDefault();var l=oe(o.getState()),c=l.item,u=l.itemInputValue,d=l.itemUrl,p=l.source;if(t.metaKey||t.ctrlKey)void 0!==d&&(p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),n.navigator.navigateNewTab({itemUrl:d,item:c,state:o.getState()}));else if(t.shiftKey)void 0!==d&&(p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),n.navigator.navigateNewWindow({itemUrl:d,item:c,state:o.getState()}));else if(t.altKey);else{if(void 0!==d)return p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),void n.navigator.navigate({itemUrl:d,item:c,state:o.getState()});Ue(Ge({event:t,nextState:{isOpen:!1},props:n,query:u,refresh:r,store:o},a)).then((function(){p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a))}))}}}(nt({event:e,props:t,refresh:n,store:r},o))},onFocus:i,onBlur:_,onClick:function(n){e.inputElement!==t.environment.document.activeElement||r.getState().isOpen||i(n)}},u)},getPanelProps:function(e){return nt({onMouseDown:function(e){e.preventDefault()},onMouseLeave:function(){r.dispatch("mouseleave",null)}},e)},getListProps:function(e){var n=e||{},r=n.sourceIndex,o=ot(n,Xe);return nt({role:"listbox","aria-labelledby":"".concat(a(t.id,r),"-label"),id:"".concat(a(t.id,r),"-list")},o)},getItemProps:function(e){var i=e.item,s=e.source,l=e.sourceIndex,c=ot(e,et);return nt({id:"".concat(a(t.id,l),"-item-").concat(i.__autocomplete_id),role:"option","aria-selected":r.getState().activeItemId===i.__autocomplete_id,onMouseMove:function(e){if(i.__autocomplete_id!==r.getState().activeItemId){r.dispatch("mousemove",i.__autocomplete_id);var t=oe(r.getState());if(null!==r.getState().activeItemId&&t){var a=t.item,s=t.itemInputValue,l=t.itemUrl,c=t.source;c.onActive(nt({event:e,item:a,itemInputValue:s,itemUrl:l,refresh:n,source:c,state:r.getState()},o))}}},onMouseDown:function(e){e.preventDefault()},onClick:function(e){var a=s.getItemInputValue({item:i,state:r.getState()}),l=s.getItemUrl({item:i,state:r.getState()});(l?Promise.resolve():Ue(nt({event:e,nextState:{isOpen:!1},props:t,query:a,refresh:n,store:r},o))).then((function(){s.onSelect(nt({event:e,item:i,itemInputValue:a,itemUrl:l,refresh:n,source:s,state:r.getState()},o))}))}},c)}}}function it(e){return it="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},it(e)}function st(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function lt(e){for(var t=1;t0&&r.createElement("div",{className:"DocSearch-NoResults-Prefill-List"},r.createElement("p",{className:"DocSearch-Help"},c,":"),r.createElement("ul",null,h.slice(0,3).reduce((function(e,t){return[].concat(u(e),[r.createElement("li",{key:t},r.createElement("button",{className:"DocSearch-Prefill",key:t,type:"button",onClick:function(){o.setQuery(t.toLowerCase()+" "),o.refresh(),o.inputRef.current.focus()}},t))])}),[]))),o.getMissingResultsUrl&&r.createElement("p",{className:"DocSearch-Help"},"".concat(p," "),r.createElement("a",{href:o.getMissingResultsUrl({query:o.state.query}),target:"_blank",rel:"noopener noreferrer"},m)))}var zt=["hit","attribute","tagName"];function Ut(e,t){return t.split(".").reduce((function(e,t){return null!=e&&e[t]?e[t]:null}),e)}function $t(e){var t=e.hit,n=e.attribute,o=e.tagName,i=void 0===o?"span":o,s=l(e,zt);return(0,r.createElement)(i,a(a({},s),{},{dangerouslySetInnerHTML:{__html:Ut(t,"_snippetResult.".concat(n,".value"))||Ut(t,n)}}))}function qt(e){return e.collection&&0!==e.collection.items.length?r.createElement("section",{className:"DocSearch-Hits"},r.createElement("div",{className:"DocSearch-Hit-source"},e.title),r.createElement("ul",e.getListProps(),e.collection.items.map((function(t,n){return r.createElement(Ht,s({key:[e.title,t.objectID].join(":"),item:t,index:n},e))})))):null}function Ht(e){var t=e.item,n=e.index,o=e.renderIcon,a=e.renderAction,i=e.getItemProps,l=e.onItemClick,u=e.collection,d=e.hitComponent,p=c(r.useState(!1),2),f=p[0],m=p[1],h=c(r.useState(!1),2),g=h[0],b=h[1],y=r.useRef(null),v=d;return r.createElement("li",s({className:["DocSearch-Hit",t.__docsearch_parent&&"DocSearch-Hit--Child",f&&"DocSearch-Hit--deleting",g&&"DocSearch-Hit--favoriting"].filter(Boolean).join(" "),onTransitionEnd:function(){y.current&&y.current()}},i({item:t,source:u.source,onClick:function(e){l(t,e)}})),r.createElement(v,{hit:t},r.createElement("div",{className:"DocSearch-Hit-Container"},o({item:t,index:n}),t.hierarchy[t.type]&&"lvl1"===t.type&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"hierarchy.lvl1"}),t.content&&r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"content"})),t.hierarchy[t.type]&&("lvl2"===t.type||"lvl3"===t.type||"lvl4"===t.type||"lvl5"===t.type||"lvl6"===t.type)&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"hierarchy.".concat(t.type)}),r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"hierarchy.lvl1"})),"content"===t.type&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"content"}),r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"hierarchy.lvl1"})),a({item:t,runDeleteTransition:function(e){m(!0),y.current=e},runFavoriteTransition:function(e){b(!0),y.current=e}}))))}function Gt(e,t,n){return e.reduce((function(e,r){var o=t(r);return e.hasOwnProperty(o)||(e[o]=[]),e[o].length<(n||5)&&e[o].push(r),e}),{})}function Vt(e){return e}function Wt(e){return 1===e.button||e.altKey||e.ctrlKey||e.metaKey||e.shiftKey}function Kt(){}var Qt=/(|<\/mark>)/g,Yt=RegExp(Qt.source);function Zt(e){var t,n,r=e;if(!r.__docsearch_parent&&!e._highlightResult)return e.hierarchy.lvl0;var o=((r.__docsearch_parent?null===(t=r.__docsearch_parent)||void 0===t||null===(t=t._highlightResult)||void 0===t||null===(t=t.hierarchy)||void 0===t?void 0:t.lvl0:null===(n=e._highlightResult)||void 0===n||null===(n=n.hierarchy)||void 0===n?void 0:n.lvl0)||{}).value;return o&&Yt.test(o)?o.replace(Qt,""):o}function Jt(e){return r.createElement("div",{className:"DocSearch-Dropdown-Container"},e.state.collections.map((function(t){if(0===t.items.length)return null;var n=Zt(t.items[0]);return r.createElement(qt,s({},e,{key:t.source.sourceId,title:n,collection:t,renderIcon:function(e){var n,o=e.item,a=e.index;return r.createElement(r.Fragment,null,o.__docsearch_parent&&r.createElement("svg",{className:"DocSearch-Hit-Tree",viewBox:"0 0 24 54"},r.createElement("g",{stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"},o.__docsearch_parent!==(null===(n=t.items[a+1])||void 0===n?void 0:n.__docsearch_parent)?r.createElement("path",{d:"M8 6v21M20 27H8.3"}):r.createElement("path",{d:"M8 6v42M20 27H8.3"}))),r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(jt,{type:o.type})))},renderAction:function(){return r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement(Tt,null))}}))})),e.resultsFooterComponent&&r.createElement("section",{className:"DocSearch-HitsFooter"},r.createElement(e.resultsFooterComponent,{state:e.state})))}var Xt=["translations"];function en(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,Xt),a=n.recentSearchesTitle,i=void 0===a?"Recent":a,c=n.noRecentSearchesText,u=void 0===c?"No recent searches":c,d=n.saveRecentSearchButtonTitle,p=void 0===d?"Save this search":d,f=n.removeRecentSearchButtonTitle,m=void 0===f?"Remove this search from history":f,h=n.favoriteSearchesTitle,g=void 0===h?"Favorite":h,b=n.removeFavoriteSearchButtonTitle,y=void 0===b?"Remove this search from favorites":b;return"idle"===o.state.status&&!1===o.hasCollections?o.disableUserPersonalization?null:r.createElement("div",{className:"DocSearch-StartScreen"},r.createElement("p",{className:"DocSearch-Help"},u)):!1===o.hasCollections?null:r.createElement("div",{className:"DocSearch-Dropdown-Container"},r.createElement(qt,s({},o,{title:i,collection:o.state.collections[0],renderIcon:function(){return r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(Ot,null))},renderAction:function(e){var t=e.item,n=e.runFavoriteTransition,a=e.runDeleteTransition;return r.createElement(r.Fragment,null,r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:p,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),n((function(){o.favoriteSearches.add(t),o.recentSearches.remove(t),o.refresh()}))}},r.createElement(Dt,null))),r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:m,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),a((function(){o.recentSearches.remove(t),o.refresh()}))}},r.createElement(Pt,null))))}})),r.createElement(qt,s({},o,{title:g,collection:o.state.collections[1],renderIcon:function(){return r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(Dt,null))},renderAction:function(e){var t=e.item,n=e.runDeleteTransition;return r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:y,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),n((function(){o.favoriteSearches.remove(t),o.refresh()}))}},r.createElement(Pt,null)))}})))}var tn=["translations"],nn=r.memo((function(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,tn);if("error"===o.state.status)return r.createElement(Mt,{translations:null==n?void 0:n.errorScreen});var a=o.state.collections.some((function(e){return e.items.length>0}));return o.state.query?!1===a?r.createElement(Bt,s({},o,{translations:null==n?void 0:n.noResultsScreen})):r.createElement(Jt,o):r.createElement(en,s({},o,{hasCollections:a,translations:null==n?void 0:n.startScreen}))}),(function(e,t){return"loading"===t.state.status||"stalled"===t.state.status})),rn=["translations"];function on(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,rn),a=n.resetButtonTitle,i=void 0===a?"Clear the query":a,c=n.resetButtonAriaLabel,u=void 0===c?"Clear the query":c,d=n.cancelButtonText,p=void 0===d?"Cancel":d,f=n.cancelButtonAriaLabel,h=void 0===f?"Cancel":f,g=n.searchInputLabel,b=void 0===g?"Search":g,y=o.getFormProps({inputElement:o.inputRef.current}).onReset;return r.useEffect((function(){o.autoFocus&&o.inputRef.current&&o.inputRef.current.focus()}),[o.autoFocus,o.inputRef]),r.useEffect((function(){o.isFromSelection&&o.inputRef.current&&o.inputRef.current.select()}),[o.isFromSelection,o.inputRef]),r.createElement(r.Fragment,null,r.createElement("form",{className:"DocSearch-Form",onSubmit:function(e){e.preventDefault()},onReset:y},r.createElement("label",s({className:"DocSearch-MagnifierLabel"},o.getLabelProps()),r.createElement(m,null),r.createElement("span",{className:"DocSearch-VisuallyHiddenForAccessibility"},b)),r.createElement("div",{className:"DocSearch-LoadingIndicator"},r.createElement(Ct,null)),r.createElement("input",s({className:"DocSearch-Input",ref:o.inputRef},o.getInputProps({inputElement:o.inputRef.current,autoFocus:o.autoFocus,maxLength:64}))),r.createElement("button",{type:"reset",title:i,className:"DocSearch-Reset","aria-label":u,hidden:!o.state.query},r.createElement(Pt,null))),r.createElement("button",{className:"DocSearch-Cancel",type:"reset","aria-label":h,onClick:o.onClose},p))}var an=["_highlightResult","_snippetResult"];function sn(e){var t=e.key,n=e.limit,r=void 0===n?5:n,o=function(e){return!1===function(){var e="__TEST_KEY__";try{return localStorage.setItem(e,""),localStorage.removeItem(e),!0}catch(e){return!1}}()?{setItem:function(){},getItem:function(){return[]}}:{setItem:function(t){return window.localStorage.setItem(e,JSON.stringify(t))},getItem:function(){var t=window.localStorage.getItem(e);return t?JSON.parse(t):[]}}}(t),a=o.getItem().slice(0,r);return{add:function(e){var t=e,n=(t._highlightResult,t._snippetResult,l(t,an)),i=a.findIndex((function(e){return e.objectID===n.objectID}));i>-1&&a.splice(i,1),a.unshift(n),a=a.slice(0,r),o.setItem(a)},remove:function(e){a=a.filter((function(t){return t.objectID!==e.objectID})),o.setItem(a)},getAll:function(){return a}}}function ln(e){const t=`algoliasearch-client-js-${e.key}`;let n;const r=()=>(void 0===n&&(n=e.localStorage||window.localStorage),n),o=()=>JSON.parse(r().getItem(t)||"{}"),a=e=>{r().setItem(t,JSON.stringify(e))};return{get:(t,n,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{(()=>{const t=e.timeToLive?1e3*e.timeToLive:null,n=o(),r=Object.fromEntries(Object.entries(n).filter((([,e])=>void 0!==e.timestamp)));if(a(r),!t)return;const i=Object.fromEntries(Object.entries(r).filter((([,e])=>{const n=(new Date).getTime();return!(e.timestamp+tPromise.all([e?e.value:n(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,n)=>Promise.resolve().then((()=>{const a=o();return a[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:n},r().setItem(t,JSON.stringify(a)),n})),delete:e=>Promise.resolve().then((()=>{const n=o();delete n[JSON.stringify(e)],r().setItem(t,JSON.stringify(n))})),clear:()=>Promise.resolve().then((()=>{r().removeItem(t)}))}}function cn(e){const t=[...e.caches],n=t.shift();return void 0===n?{get:(e,t,n={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,n.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,r,o={miss:()=>Promise.resolve()})=>n.get(e,r,o).catch((()=>cn({caches:t}).get(e,r,o))),set:(e,r)=>n.set(e,r).catch((()=>cn({caches:t}).set(e,r))),delete:e=>n.delete(e).catch((()=>cn({caches:t}).delete(e))),clear:()=>n.clear().catch((()=>cn({caches:t}).clear()))}}function un(e={serializable:!0}){let t={};return{get(n,r,o={miss:()=>Promise.resolve()}){const a=JSON.stringify(n);if(a in t)return Promise.resolve(e.serializable?JSON.parse(t[a]):t[a]);const i=r(),s=o&&o.miss||(()=>Promise.resolve());return i.then((e=>s(e))).then((()=>i))},set:(n,r)=>(t[JSON.stringify(n)]=e.serializable?JSON.stringify(r):r,Promise.resolve(r)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}function dn(e){let t=e.length-1;for(;t>0;t--){const n=Math.floor(Math.random()*(t+1)),r=e[t];e[t]=e[n],e[n]=r}return e}function pn(e,t){return t?(Object.keys(t).forEach((n=>{e[n]=t[n](e)})),e):e}function fn(e,...t){let n=0;return e.replace(/%s/g,(()=>encodeURIComponent(t[n++])))}const mn={WithinQueryParameters:0,WithinHeaders:1};function hn(e,t){const n=e||{},r=n.data||{};return Object.keys(n).forEach((e=>{-1===["timeout","headers","queryParameters","data","cacheable"].indexOf(e)&&(r[e]=n[e])})),{data:Object.entries(r).length>0?r:void 0,timeout:n.timeout||t,headers:n.headers||{},queryParameters:n.queryParameters||{},cacheable:n.cacheable}}const gn={Read:1,Write:2,Any:3},bn=1,yn=3;function vn(e,t=bn){return{...e,status:t,lastUpdate:Date.now()}}function wn(e){return"string"==typeof e?{protocol:"https",url:e,accept:gn.Any}:{protocol:e.protocol||"https",url:e.url,accept:e.accept||gn.Any}}const Sn="GET",kn="POST";function xn(e,t,n,r){const o=[],a=function(e,t){if(e.method===Sn||void 0===e.data&&void 0===t.data)return;const n=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(n)}(n,r),i=function(e,t){const n={...e.headers,...t.headers},r={};return Object.keys(n).forEach((e=>{const t=n[e];r[e.toLowerCase()]=t})),r}(e,r),s=n.method,l=n.method!==Sn?{}:{...n.data,...r.data},c={"x-algolia-agent":e.userAgent.value,...e.queryParameters,...l,...r.queryParameters};let u=0;const d=(t,l)=>{const p=t.pop();if(void 0===p)throw{name:"RetryError",message:"Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",transporterStackTrace:On(o)};const f={data:a,headers:i,method:s,url:En(p,n.path,c),connectTimeout:l(u,e.timeouts.connect),responseTimeout:l(u,r.timeout)},m=e=>{const n={request:f,response:e,host:p,triesLeft:t.length};return o.push(n),n},h={onSuccess:e=>function(e){try{return JSON.parse(e.content)}catch(t){throw function(e,t){return{name:"DeserializationError",message:e,response:t}}(t.message,e)}}(e),onRetry(n){const r=m(n);return n.isTimedOut&&u++,Promise.all([e.logger.info("Retryable failure",Pn(r)),e.hostsCache.set(p,vn(p,n.isTimedOut?yn:2))]).then((()=>d(t,l)))},onFail(e){throw m(e),function({content:e,status:t},n){let r=e;try{r=JSON.parse(e).message}catch(e){}return function(e,t,n){return{name:"ApiError",message:e,status:t,transporterStackTrace:n}}(r,t,n)}(e,On(o))}};return e.requester.send(f).then((e=>((e,t)=>(e=>{const t=e.status;return e.isTimedOut||(({isTimedOut:e,status:t})=>!e&&!~~t)(e)||2!=~~(t/100)&&4!=~~(t/100)})(e)?t.onRetry(e):(({status:e})=>2==~~(e/100))(e)?t.onSuccess(e):t.onFail(e))(e,h)))};return function(e,t){return Promise.all(t.map((t=>e.get(t,(()=>Promise.resolve(vn(t))))))).then((e=>{const n=e.filter((e=>function(e){return e.status===bn||Date.now()-e.lastUpdate>12e4}(e))),r=e.filter((e=>function(e){return e.status===yn&&Date.now()-e.lastUpdate<=12e4}(e))),o=[...n,...r];return{getTimeout:(e,t)=>(0===r.length&&0===e?1:r.length+3+e)*t,statelessHosts:o.length>0?o.map((e=>wn(e))):t}}))}(e.hostsCache,t).then((e=>d([...e.statelessHosts].reverse(),e.getTimeout)))}function _n(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const n=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(n)&&(t.value=`${t.value}${n}`),t}};return t}function En(e,t,n){const r=Cn(n);let o=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return r.length&&(o+=`?${r}`),o}function Cn(e){return Object.keys(e).map((t=>{return fn("%s=%s",t,(n=e[t],"[object Object]"===Object.prototype.toString.call(n)||"[object Array]"===Object.prototype.toString.call(n)?JSON.stringify(e[t]):e[t]));var n})).join("&")}function On(e){return e.map((e=>Pn(e)))}function Pn(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}const Tn=e=>{const t=e.appId,n=function(e,t,n){const r={"x-algolia-api-key":n,"x-algolia-application-id":t};return{headers:()=>e===mn.WithinHeaders?r:{},queryParameters:()=>e===mn.WithinQueryParameters?r:{}}}(void 0!==e.authMode?e.authMode:mn.WithinHeaders,t,e.apiKey),r=function(e){const{hostsCache:t,logger:n,requester:r,requestsCache:o,responsesCache:a,timeouts:i,userAgent:s,hosts:l,queryParameters:c,headers:u}=e,d={hostsCache:t,logger:n,requester:r,requestsCache:o,responsesCache:a,timeouts:i,userAgent:s,headers:u,queryParameters:c,hosts:l.map((e=>wn(e))),read(e,t){const n=hn(t,d.timeouts.read),r=()=>xn(d,d.hosts.filter((e=>!!(e.accept&gn.Read))),e,n);if(!0!==(void 0!==n.cacheable?n.cacheable:e.cacheable))return r();const o={request:e,mappedRequestOptions:n,transporter:{queryParameters:d.queryParameters,headers:d.headers}};return d.responsesCache.get(o,(()=>d.requestsCache.get(o,(()=>d.requestsCache.set(o,r()).then((e=>Promise.all([d.requestsCache.delete(o),e])),(e=>Promise.all([d.requestsCache.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>d.responsesCache.set(o,e)})},write:(e,t)=>xn(d,d.hosts.filter((e=>!!(e.accept&gn.Write))),e,hn(t,d.timeouts.write))};return d}({hosts:[{url:`${t}-dsn.algolia.net`,accept:gn.Read},{url:`${t}.algolia.net`,accept:gn.Write}].concat(dn([{url:`${t}-1.algolianet.com`},{url:`${t}-2.algolianet.com`},{url:`${t}-3.algolianet.com`}])),...e,headers:{...n.headers(),"content-type":"application/x-www-form-urlencoded",...e.headers},queryParameters:{...n.queryParameters(),...e.queryParameters}}),o={transporter:r,appId:t,addAlgoliaAgent(e,t){r.userAgent.add({segment:e,version:t})},clearCache:()=>Promise.all([r.requestsCache.clear(),r.responsesCache.clear()]).then((()=>{}))};return pn(o,e.methods)},An=e=>(t,n)=>t.method===Sn?e.transporter.read(t,n):e.transporter.write(t,n),jn=e=>(t,n={})=>pn({transporter:e.transporter,appId:e.appId,indexName:t},n.methods),Rn=e=>(t,n)=>{const r=t.map((e=>({...e,params:Cn(e.params||{})})));return e.transporter.read({method:kn,path:"1/indexes/*/queries",data:{requests:r},cacheable:!0},n)},In=e=>(t,n)=>Promise.all(t.map((t=>{const{facetName:r,facetQuery:o,...a}=t.params;return jn(e)(t.indexName,{methods:{searchForFacetValues:Nn}}).searchForFacetValues(r,o,{...n,...a})}))),Dn=e=>(t,n,r)=>e.transporter.read({method:kn,path:fn("1/answers/%s/prediction",e.indexName),data:{query:t,queryLanguages:n},cacheable:!0},r),Ln=e=>(t,n)=>e.transporter.read({method:kn,path:fn("1/indexes/%s/query",e.indexName),data:{query:t},cacheable:!0},n),Nn=e=>(t,n,r)=>e.transporter.read({method:kn,path:fn("1/indexes/%s/facets/%s/query",e.indexName,t),data:{facetQuery:n},cacheable:!0},r),Mn=1,Fn=2,Bn=3;function zn(e,t,n){const r={appId:e,apiKey:t,timeouts:{connect:1,read:2,write:30},requester:{send:e=>new Promise((t=>{const n=new XMLHttpRequest;n.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>n.setRequestHeader(t,e.headers[t])));const r=(e,r)=>setTimeout((()=>{n.abort(),t({status:0,content:r,isTimedOut:!0})}),1e3*e),o=r(e.connectTimeout,"Connection timeout");let a;n.onreadystatechange=()=>{n.readyState>n.OPENED&&void 0===a&&(clearTimeout(o),a=r(e.responseTimeout,"Socket timeout"))},n.onerror=()=>{0===n.status&&(clearTimeout(o),clearTimeout(a),t({content:n.responseText||"Network request failed",status:n.status,isTimedOut:!1}))},n.onload=()=>{clearTimeout(o),clearTimeout(a),t({content:n.responseText,status:n.status,isTimedOut:!1})},n.send(e.data)}))},logger:(o=Bn,{debug:(e,t)=>(Mn>=o&&console.debug(e,t),Promise.resolve()),info:(e,t)=>(Fn>=o&&console.info(e,t),Promise.resolve()),error:(e,t)=>(console.error(e,t),Promise.resolve())}),responsesCache:un(),requestsCache:un({serializable:!1}),hostsCache:cn({caches:[ln({key:`4.19.1-${e}`}),un()]}),userAgent:_n("4.19.1").add({segment:"Browser",version:"lite"}),authMode:mn.WithinQueryParameters};var o;return Tn({...r,...n,methods:{search:Rn,searchForFacetValues:In,multipleQueries:Rn,multipleSearchForFacetValues:In,customRequest:An,initIndex:e=>t=>jn(e)(t,{methods:{search:Ln,searchForFacetValues:Nn,findAnswers:Dn}})}})}zn.version="4.19.1";var Un=["footer","searchBox"];function $n(e){var t=e.appId,n=e.apiKey,o=e.indexName,i=e.placeholder,u=void 0===i?"Search docs":i,d=e.searchParameters,p=e.maxResultsPerGroup,f=e.onClose,m=void 0===f?Kt:f,h=e.transformItems,g=void 0===h?Vt:h,b=e.hitComponent,y=void 0===b?Et:b,v=e.resultsFooterComponent,w=void 0===v?function(){return null}:v,S=e.navigator,k=e.initialScrollY,x=void 0===k?0:k,_=e.transformSearchClient,E=void 0===_?Vt:_,C=e.disableUserPersonalization,O=void 0!==C&&C,P=e.initialQuery,T=void 0===P?"":P,A=e.translations,j=void 0===A?{}:A,R=e.getMissingResultsUrl,I=e.insights,D=void 0!==I&&I,L=j.footer,N=j.searchBox,M=l(j,Un),F=c(r.useState({query:"",collections:[],completion:null,context:{},isOpen:!1,activeItemId:null,status:"idle"}),2),B=F[0],z=F[1],U=r.useRef(null),$=r.useRef(null),q=r.useRef(null),H=r.useRef(null),G=r.useRef(null),V=r.useRef(10),W=r.useRef("undefined"!=typeof window?window.getSelection().toString().slice(0,64):"").current,K=r.useRef(T||W).current,Q=function(e,t,n){return r.useMemo((function(){var r=zn(e,t);return r.addAlgoliaAgent("docsearch","3.6.1"),!1===/docsearch.js \(.*\)/.test(r.transporter.userAgent.value)&&r.addAlgoliaAgent("docsearch-react","3.6.1"),n(r)}),[e,t,n])}(t,n,E),Y=r.useRef(sn({key:"__DOCSEARCH_FAVORITE_SEARCHES__".concat(o),limit:10})).current,Z=r.useRef(sn({key:"__DOCSEARCH_RECENT_SEARCHES__".concat(o),limit:0===Y.getAll().length?7:4})).current,J=r.useCallback((function(e){if(!O){var t="content"===e.type?e.__docsearch_parent:e;t&&-1===Y.getAll().findIndex((function(e){return e.objectID===t.objectID}))&&Z.add(t)}}),[Y,Z,O]),X=r.useCallback((function(e){if(B.context.algoliaInsightsPlugin&&e.__autocomplete_id){var t=e,n={eventName:"Item Selected",index:t.__autocomplete_indexName,items:[t],positions:[e.__autocomplete_id],queryID:t.__autocomplete_queryID};B.context.algoliaInsightsPlugin.insights.clickedObjectIDsAfterSearch(n)}}),[B.context.algoliaInsightsPlugin]),ee=r.useMemo((function(){return St({id:"docsearch",defaultActiveItemId:0,placeholder:u,openOnFocus:!0,initialState:{query:K,context:{searchSuggestions:[]}},insights:D,navigator:S,onStateChange:function(e){z(e.state)},getSources:function(e){var r=e.query,i=e.state,s=e.setContext,l=e.setStatus;if(!r)return O?[]:[{sourceId:"recentSearches",onSelect:function(e){var t=e.item,n=e.event;J(t),Wt(n)||m()},getItemUrl:function(e){return e.item.url},getItems:function(){return Z.getAll()}},{sourceId:"favoriteSearches",onSelect:function(e){var t=e.item,n=e.event;J(t),Wt(n)||m()},getItemUrl:function(e){return e.item.url},getItems:function(){return Y.getAll()}}];var c=Boolean(D);return Q.search([{query:r,indexName:o,params:a({attributesToRetrieve:["hierarchy.lvl0","hierarchy.lvl1","hierarchy.lvl2","hierarchy.lvl3","hierarchy.lvl4","hierarchy.lvl5","hierarchy.lvl6","content","type","url"],attributesToSnippet:["hierarchy.lvl1:".concat(V.current),"hierarchy.lvl2:".concat(V.current),"hierarchy.lvl3:".concat(V.current),"hierarchy.lvl4:".concat(V.current),"hierarchy.lvl5:".concat(V.current),"hierarchy.lvl6:".concat(V.current),"content:".concat(V.current)],snippetEllipsisText:"\u2026",highlightPreTag:"",highlightPostTag:"",hitsPerPage:20,clickAnalytics:c},d)}]).catch((function(e){throw"RetryError"===e.name&&l("error"),e})).then((function(e){var r=e.results[0],l=r.hits,u=r.nbHits,d=Gt(l,(function(e){return Zt(e)}),p);i.context.searchSuggestions.length0&&(re(),G.current&&G.current.focus())}),[K,re]),r.useEffect((function(){function e(){if($.current){var e=.01*window.innerHeight;$.current.style.setProperty("--docsearch-vh","".concat(e,"px"))}}return e(),window.addEventListener("resize",e),function(){window.removeEventListener("resize",e)}}),[]),r.createElement("div",s({ref:U},ne({"aria-expanded":!0}),{className:["DocSearch","DocSearch-Container","stalled"===B.status&&"DocSearch-Container--Stalled","error"===B.status&&"DocSearch-Container--Errored"].filter(Boolean).join(" "),role:"button",tabIndex:0,onMouseDown:function(e){e.target===e.currentTarget&&m()}}),r.createElement("div",{className:"DocSearch-Modal",ref:$},r.createElement("header",{className:"DocSearch-SearchBar",ref:q},r.createElement(on,s({},ee,{state:B,autoFocus:0===K.length,inputRef:G,isFromSelection:Boolean(K)&&K===W,translations:N,onClose:m}))),r.createElement("div",{className:"DocSearch-Dropdown",ref:H},r.createElement(nn,s({},ee,{indexName:o,state:B,hitComponent:y,resultsFooterComponent:w,disableUserPersonalization:O,recentSearches:Z,favoriteSearches:Y,inputRef:G,translations:M,getMissingResultsUrl:R,onItemClick:function(e,t){X(e),J(e),Wt(t)||m()}}))),r.createElement("footer",{className:"DocSearch-Footer"},r.createElement(_t,{translations:L}))))}function qn(e){var t=e.isOpen,n=e.onOpen,o=e.onClose,a=e.onInput,i=e.searchButtonRef;r.useEffect((function(){function e(e){var r;(27===e.keyCode&&t||"k"===(null===(r=e.key)||void 0===r?void 0:r.toLowerCase())&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,n=t.tagName;return t.isContentEditable||"INPUT"===n||"SELECT"===n||"TEXTAREA"===n}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?o():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||n()),i&&i.current===document.activeElement&&a&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&a(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,n,o,a,i])}},8328:(e,t,n)=>{"use strict";n.d(t,{A:()=>p});n(6540);var r=n(3259),o=n.n(r),a=n(4054);const i={"0057296d":[()=>n.e(1482).then(n.bind(n,3667)),"@site/docs/how-to/send-messages.md",3667],"0058b4c6":[()=>n.e(849).then(n.t.bind(n,6164,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-175.json",6164],"00c93e1e":[()=>n.e(9837).then(n.bind(n,8397)),"@site/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",8397],"00f29cf5":[()=>n.e(4424).then(n.bind(n,3999)),"@site/docs/reference/controllers/events/index.md",3999],"01a85c17":[()=>Promise.all([n.e(1869),n.e(8209)]).then(n.bind(n,9158)),"@theme/BlogTagsListPage",9158],"0274794e":[()=>n.e(6377).then(n.bind(n,1494)),"@site/docs/reference/api/Client/index.md",1494],"037298f3":[()=>n.e(1865).then(n.bind(n,6200)),"@site/docs/reference/api/model/product/interfaces/Product.md",6200],"0523356b":[()=>n.e(9571).then(n.bind(n,362)),"@site/docs/reference/api/model/chat/interfaces/SingleChat.md",362],"0673617b":[()=>n.e(1543).then(n.bind(n,5010)),"@site/docs/reference/api/model/id/index.md",5010],"0730592b":[()=>n.e(2419).then(n.bind(n,7094)),"@site/docs/reference/controllers/initializer/variables/pkg.md",7094],"081c0950":[()=>n.e(5029).then(n.bind(n,9995)),"@site/docs/reference/api/model/message/enumerations/MessageTypes.md",9995],"099caee3":[()=>n.e(4508).then(n.bind(n,4870)),"@site/docs/reference/api/model/aliases/type-aliases/DataURL.md",4870],"0a59a0e8":[()=>n.e(9544).then(n.bind(n,7499)),"@site/docs/reference/controllers/initializer/functions/timeout.md",7499],"0b9397d6":[()=>n.e(3755).then(n.bind(n,5165)),"@site/docs/reference/api/model/chat/enumerations/ChatState.md",5165],"0bf84b24":[()=>n.e(6403).then(n.bind(n,9909)),"@site/docs/reference/api/model/contact/interfaces/NumberCheck.md",9909],"0d185c55":[()=>n.e(990).then(n.bind(n,5547)),"@site/docs/configuration/command-line-options.md",5547],"0d1f64ba":[()=>n.e(599).then(n.bind(n,3325)),"@site/docs/reference/api/model/config/interfaces/ConfigObject.md",3325],"0e0f73c7":[()=>n.e(16).then(n.bind(n,3136)),"@site/docs/reference/api/model/config/enumerations/QRFormat.md",3136],"0e384e19":[()=>n.e(3976).then(n.bind(n,619)),"@site/docs/intro.md",619],"1025625c":[()=>n.e(1207).then(n.bind(n,1649)),"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",1649],"1061d0cb":[()=>n.e(4940).then(n.bind(n,4744)),"@site/docs/configuration/capture-sd.md",4744],"11347dcd":[()=>n.e(7180).then(n.bind(n,5689)),"@site/docs/reference/api/model/enumerations/Status.md",5689],"1454731d":[()=>n.e(314).then(n.bind(n,5773)),"@site/docs/reference/logging/custom_transport/classes/NoOpTransport.md",5773],"146bd2aa":[()=>n.e(9160).then(n.bind(n,5865)),"@site/docs/reference/api/model/config/enumerations/LicenseType.md",5865],"14eb3368":[()=>Promise.all([n.e(1869),n.e(6969)]).then(n.bind(n,4136)),"@theme/DocCategoryGeneratedIndexPage",4136],"150e319f":[()=>n.e(809).then(n.bind(n,3889)),"@site/docs/reference/api/model/contact/index.md",3889],"155c8334":[()=>n.e(283).then(n.bind(n,4319)),"@site/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",4319],"171e0138":[()=>n.e(5653).then(n.bind(n,809)),"@site/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",809],17896441:[()=>Promise.all([n.e(1869),n.e(8307),n.e(8401)]).then(n.bind(n,833)),"@theme/DocItem",833],18336523:[()=>n.e(240).then(n.bind(n,8895)),"@site/docs/reference/logging/custom_transport/index.md",8895],"18ad8d0a":[()=>n.e(974).then(n.bind(n,4123)),"@site/docs/configuration/launch-events.md",4123],"18c41134":[()=>n.e(9262).then(n.bind(n,3849)),"@site/docs/tutorial-basics/markdown-features.mdx",3849],"1a3c9b31":[()=>n.e(9242).then(n.bind(n,1307)),"@site/docs/reference/index.md",1307],"1a4e3797":[()=>Promise.all([n.e(1869),n.e(2138)]).then(n.bind(n,4604)),"@theme/SearchPage",4604],"1c28c6e3":[()=>n.e(1530).then(n.bind(n,9884)),"@site/docs/get-started/installation.md",9884],"1df732fe":[()=>n.e(57).then(n.bind(n,7725)),"@site/docs/reference/api/model/config/index.md",7725],"1df93b7f":[()=>Promise.all([n.e(1869),n.e(2100),n.e(4583)]).then(n.bind(n,4706)),"@site/src/pages/index.tsx",4706],"1e4232ab":[()=>n.e(1953).then(n.bind(n,3976)),"@site/docs/tutorial-basics/create-a-document.md",3976],"1f391b9e":[()=>Promise.all([n.e(1869),n.e(8307),n.e(6061)]).then(n.bind(n,7973)),"@theme/MDXPage",7973],"20288d3d":[()=>n.e(626).then(n.bind(n,8236)),"@site/docs/reference/api/model/group-metadata/interfaces/Participant.md",8236],"20fe70bf":[()=>n.e(843).then(n.bind(n,4158)),"@site/docs/how-to/decrypt-media.md",4158],"26af37c4":[()=>n.e(8745).then(n.bind(n,8114)),"@site/docs/reference/api/Client/classes/Client.md",8114],27075183:[()=>n.e(4332).then(n.bind(n,3775)),"@site/docs/reference/api/model/config/enumerations/OnError.md",3775],"279c9f30":[()=>n.e(5626).then(n.bind(n,6691)),"@site/docs/reference/logging/logging/variables/log.md",6691],"28a4b851":[()=>n.e(2166).then(n.bind(n,9820)),"@site/docs/how-to/incoming-calls.md",9820],"29a49838":[()=>n.e(3177).then(n.bind(n,412)),"@site/docs/reference/structures/Collector/interfaces/CollectorOptions.md",412],"29b289c3":[()=>n.e(747).then(n.bind(n,3214)),"@site/docs/reference/api/model/media/type-aliases/StickerMetadata.md",3214],"29fec1eb":[()=>n.e(986).then(n.bind(n,2307)),"@site/docs/how-to/send-videos.md",2307],"2b136cef":[()=>n.e(487).then(n.bind(n,5052)),"@site/docs/configuration/capture-qr.md",5052],"2ca4460e":[()=>n.e(2866).then(n.bind(n,5030)),"@site/docs/reference/api/model/aliases/type-aliases/Content.md",5030],"2d4ad45f":[()=>n.e(5341).then(n.bind(n,1538)),"@site/docs/reference/api/model/aliases/type-aliases/ContactId.md",1538],"2eaaacd8":[()=>n.e(858).then(n.bind(n,6546)),"@site/docs/reference/controllers/initializer/variables/screenshot.md",6546],"2f74e3d4":[()=>n.e(3534).then(n.bind(n,2971)),"@site/docs/reference/api/model/product/interfaces/Order.md",2971],"2fc4fc5f":[()=>n.e(730).then(n.bind(n,1619)),"@site/docs/reference/api/model/button/interfaces/Section.md",1619],"3217192f":[()=>n.e(8462).then(n.t.bind(n,8174,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-docusaurus-f20.json",8174],"3486d072":[()=>n.e(3003).then(n.bind(n,7708)),"@site/docs/reference/controllers/patch_manager/index.md",7708],"36994c47":[()=>n.e(9858).then(n.t.bind(n,5516,19)),"@generated/docusaurus-plugin-content-blog/default/__plugin.json",5516],"393be207":[()=>n.e(4134).then(n.bind(n,633)),"@site/src/pages/markdown-page.md",633],"3a2db09e":[()=>n.e(8121).then(n.t.bind(n,8070,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-df9.json",8070],"3bb4bcf6":[()=>n.e(8223).then(n.bind(n,4966)),"@site/docs/reference/api/model/message/interfaces/PollVote.md",4966],"3d3a9b6d":[()=>n.e(1181).then(n.bind(n,3826)),"@site/docs/reference/controllers/initializer/index.md",3826],"3de6a3bc":[()=>n.e(9178).then(n.bind(n,8566)),"@site/docs/reference/api/model/contact/interfaces/Contact.md",8566],"3edf7b61":[()=>n.e(2801).then(n.bind(n,6374)),"@site/docs/reference/api/model/aliases/type-aliases/FilePath.md",6374],"402fd8ec":[()=>n.e(2007).then(n.bind(n,5434)),"@site/docs/reference/api/model/config/enumerations/QRQuality.md",5434],"4197358a":[()=>n.e(8867).then(n.bind(n,6014)),"@site/docs/reference/api/model/events/index.md",6014],"428f4992":[()=>n.e(815).then(n.bind(n,8183)),"@site/docs/reference/api/model/label/index.md",8183],"437a86f0":[()=>n.e(3272).then(n.bind(n,4470)),"@site/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",4470],"45205a09":[()=>n.e(1359).then(n.bind(n,7112)),"@site/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",7112],"4640f537":[()=>n.e(8512).then(n.bind(n,5951)),"@site/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",5951],"465af148":[()=>n.e(3268).then(n.bind(n,1136)),"@site/docs/reference/api/model/aliases/type-aliases/ChatId.md",1136],"4689dc6f":[()=>n.e(1939).then(n.bind(n,3521)),"@site/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",3521],"468b357e":[()=>n.e(6315).then(n.bind(n,5138)),"@site/docs/reference/api/model/aliases/type-aliases/GetURL.md",5138],"484e5a84":[()=>n.e(6956).then(n.bind(n,9188)),"@site/docs/reference/api/model/aliases/type-aliases/CountryCode.md",9188],"4a1784a5":[()=>n.e(1124).then(n.bind(n,4758)),"@site/docs/Integrations/chatwoot.md",4758],"4b6dedc4":[()=>n.e(493).then(n.bind(n,6909)),"@site/docs/reference/api/model/button/interfaces/LocationButtonBody.md",6909],"4bc6cdf6":[()=>n.e(9223).then(n.bind(n,3337)),"@site/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",3337],"52c02df4":[()=>n.e(8283).then(n.bind(n,1802)),"@site/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",1802],"52eba09e":[()=>n.e(2254).then(n.bind(n,4515)),"@site/docs/reference/api/model/chat/interfaces/GroupChat.md",4515],"533a09ca":[()=>n.e(3098).then(n.bind(n,4700)),"@site/docs/tutorial-basics/create-a-blog-post.md",4700],"5471f4ea":[()=>n.e(6724).then(n.bind(n,6631)),"@site/docs/configuration/the-client.md",6631],"54b7f2e2":[()=>n.e(6496).then(n.bind(n,8892)),"@site/docs/reference/api/model/button/interfaces/Row.md",8892],"54d2ec5f":[()=>n.e(4711).then(n.bind(n,291)),"@site/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",291],"57a2de75":[()=>n.e(2147).then(n.bind(n,6863)),"@site/docs/reference/controllers/initializer/variables/configWithCases.md",6863],"58bfaad8":[()=>n.e(86).then(n.bind(n,8146)),"@site/docs/reference/api/model/call/interfaces/Call.md",8146],59362658:[()=>n.e(9325).then(n.bind(n,1180)),"@site/blog/2021-08-01-mdx-blog-post.mdx",1180],"5c868d36":[()=>n.e(1974).then(n.bind(n,5254)),"@site/docs/tutorial-basics/create-a-page.md",5254],"5cc50a6c":[()=>n.e(907).then(n.bind(n,952)),"@site/docs/how-to/misc.md",952],"5e01f171":[()=>n.e(1695).then(n.bind(n,3185)),"@site/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",3185],"5e8c322a":[()=>n.e(594).then(n.bind(n,3478)),"@site/docs/api/index.md",3478],"5e90a9b3":[()=>n.e(8025).then(n.t.bind(n,7134,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hola-73f.json",7134],"5e95c892":[()=>n.e(9647).then(n.bind(n,7121)),"@theme/DocsRoot",7121],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,4784)),"@generated/docusaurus.config",4784],"5ebba8c8":[()=>n.e(7615).then(n.bind(n,7892)),"@site/docs/how-to/groups.md",7892],"5ee7b1bc":[()=>n.e(1743).then(n.bind(n,7163)),"@site/docs/concepts/glossary.md",7163],"5f2ffadc":[()=>n.e(9850).then(n.bind(n,8320)),"@site/docs/concepts/how-it-works.md",8320],"5f617a4c":[()=>n.e(3814).then(n.bind(n,6910)),"@site/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",6910],"5fd2b997":[()=>n.e(707).then(n.bind(n,3160)),"@site/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",3160],"60a6a9a9":[()=>n.e(8444).then(n.bind(n,6031)),"@site/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",6031],"60b52a9d":[()=>n.e(6002).then(n.bind(n,3290)),"@site/docs/reference/api/model/enumerations/STATE.md",3290],"621db11d":[()=>Promise.all([n.e(1869),n.e(3347),n.e(4212)]).then(n.bind(n,3250)),"@theme/Blog/Pages/BlogAuthorsListPage",3250],"64bd8bad":[()=>n.e(1642).then(n.bind(n,8807)),"@site/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",8807],"6679ae86":[()=>n.e(6647).then(n.bind(n,743)),"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",743],"6844db42":[()=>n.e(7657).then(n.bind(n,2060)),"@site/docs/how-to/handle-errors.md",2060],"6875c492":[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(4813)]).then(n.bind(n,3069)),"@theme/BlogTagsPostsPage",3069],"6922041d":[()=>n.e(7807).then(n.bind(n,6453)),"@site/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",6453],"6afe94c3":[()=>n.e(6290).then(n.bind(n,492)),"@site/docs/reference/api/model/button/interfaces/AdvancedButton.md",492],"6b55e007":[()=>n.e(8773).then(n.bind(n,6722)),"@site/docs/configuration/config-object.md",6722],"6b7169bc":[()=>n.e(3809).then(n.bind(n,9522)),"@site/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",9522],"6bb166bd":[()=>n.e(8518).then(n.t.bind(n,3618,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-tutorial-extras-128.json",3618],"6bd61230":[()=>n.e(5293).then(n.bind(n,2483)),"@site/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",2483],"6cdb92a9":[()=>n.e(2987).then(n.bind(n,6050)),"@site/docs/get-started/socketmode.md",6050],"6dda1eb8":[()=>n.e(7856).then(n.bind(n,4551)),"@site/docs/reference/api/model/group-metadata/index.md",4551],"6de276b4":[()=>n.e(6521).then(n.bind(n,6363)),"@site/docs/reference/api/model/call/index.md",6363],"6f5ae7fe":[()=>n.e(998).then(n.bind(n,8642)),"@site/docs/how-to/use-a-proxy.md",8642],"6f941ca8":[()=>n.e(6155).then(n.bind(n,3135)),"@site/docs/how-to/location.md",3135],"70bd31a0":[()=>n.e(727).then(n.bind(n,5705)),"@site/docs/reference/api/model/contact/interfaces/BusinessProfile.md",5705],"71e949d7":[()=>n.e(1623).then(n.bind(n,830)),"@site/docs/reference/controllers/events/variables/ev.md",830],"72bcfeeb":[()=>n.e(3795).then(n.bind(n,6506)),"@site/docs/reference/controllers/initializer/functions/create.md",6506],"73664a40":[()=>n.e(1972).then(n.bind(n,9581)),"@site/blog/2019-05-29-long-blog-post.md",9581],"73c627ad":[()=>n.e(5972).then(n.bind(n,4933)),"@site/docs/reference/api/model/product/interfaces/CustomProduct.md",4933],"73d41d19":[()=>n.e(5352).then(n.bind(n,2970)),"@site/docs/reference/api/model/index.md",2970],"745741e5":[()=>n.e(1121).then(n.bind(n,1214)),"@site/docs/reference/api/model/id/interfaces/Id.md",1214],"7628d2f1":[()=>n.e(6067).then(n.bind(n,5468)),"@site/docs/reference/api/Client/enumerations/namespace.md",5468],"7661071f":[()=>n.e(8737).then(n.bind(n,4137)),"@site/blog/2021-08-26-welcome/index.md?truncated=true",4137],"7803af04":[()=>n.e(1536).then(n.bind(n,3958)),"@site/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",3958],"792432d4":[()=>n.e(2426).then(n.bind(n,9341)),"@site/docs/reference/api/model/aliases/type-aliases/GroupId.md",9341],"79bb96de":[()=>n.e(6851).then(n.bind(n,4868)),"@site/docs/how-to/receive-messages.md",4868],"7c769d76":[()=>n.e(8726).then(n.bind(n,4662)),"@site/docs/how-to/detect-logout.md",4662],"7d55d1f2":[()=>n.e(7157).then(n.bind(n,7342)),"@site/docs/reference/api/model/label/interfaces/Label.md",7342],"7e283186":[()=>n.e(2119).then(n.bind(n,1040)),"@site/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",1040],"80965edc":[()=>n.e(6555).then(n.bind(n,6794)),"@site/docs/reference/structures/Collector/index.md",6794],"814f3328":[()=>n.e(7472).then(n.t.bind(n,5513,19)),"~blog/default/blog-post-list-prop-default.json",5513],"822bd8ab":[()=>n.e(2748).then(n.bind(n,8611)),"@site/docs/tutorial-basics/congratulations.md",8611],"82a3a055":[()=>n.e(2040).then(n.bind(n,8154)),"@site/docs/reference/structures/Dialog/interfaces/DialogButtons.md",8154],"83d3b456":[()=>n.e(8976).then(n.bind(n,678)),"@site/docs/reference/api/model/product/index.md",678],"846f0159":[()=>n.e(6336).then(n.bind(n,5866)),"@site/docs/reference/api/model/aliases/type-aliases/ChatServer.md",5866],"8717b14a":[()=>n.e(3694).then(n.bind(n,1615)),"@site/blog/2019-05-29-long-blog-post.md?truncated=true",1615],"8997cb84":[()=>n.e(1397).then(n.bind(n,8697)),"@site/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",8697],"8a0e406a":[()=>n.e(4696).then(n.bind(n,9516)),"@site/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",9516],"8a376d68":[()=>n.e(1808).then(n.bind(n,8086)),"@site/docs/reference/api/model/events/enumerations/SimpleListener.md",8086],"8ebd32b9":[()=>n.e(1800).then(n.bind(n,2594)),"@site/docs/reference/structures/MessageCollector/classes/MessageCollector.md",2594],"8ee4cc26":[()=>n.e(8563).then(n.bind(n,1856)),"@site/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",1856],"8fbd3a7f":[()=>n.e(9596).then(n.bind(n,6327)),"@site/docs/reference/api/model/chat/interfaces/BaseChat.md",6327],"901c4e03":[()=>n.e(1302).then(n.bind(n,269)),"@site/docs/how-to/create-api.md",269],"91a766d9":[()=>n.e(2392).then(n.bind(n,6522)),"@site/docs/configuration/multiple-sessions.md",6522],"925b3f96":[()=>n.e(8609).then(n.bind(n,5026)),"@site/blog/2019-05-28-first-blog-post.md?truncated=true",5026],"9403ec86":[()=>n.e(3689).then(n.bind(n,1204)),"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",1204],95628813:[()=>n.e(9153).then(n.bind(n,648)),"@site/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",648],"98c048de":[()=>n.e(488).then(n.bind(n,7190)),"@site/docs/reference/api/model/config/interfaces/SessionData.md",7190],"9a514765":[()=>n.e(9099).then(n.bind(n,6873)),"@site/docs/reference/api/model/chat/enumerations/ChatTypes.md",6873],"9aa93c82":[()=>n.e(3703).then(n.bind(n,865)),"@site/docs/reference/api/model/media/index.md",865],"9ab3d06b":[()=>n.e(3128).then(n.bind(n,7986)),"@site/docs/reference/api/model/enumerations/Events.md",7986],"9bd6a0c8":[()=>n.e(3354).then(n.bind(n,5315)),"@site/docs/reference/structures/Dialog/interfaces/DialogProperty.md",5315],"9d5f1ccb":[()=>n.e(2910).then(n.bind(n,1203)),"@site/docs/reference/api/model/button/index.md",1203],"9e4087bc":[()=>n.e(2711).then(n.bind(n,9331)),"@theme/BlogArchivePage",9331],a08b55b4:[()=>n.e(7746).then(n.bind(n,7331)),"@site/docs/reference/api/model/aliases/type-aliases/WaServers.md",7331],a0ef4106:[()=>n.e(2534).then(n.bind(n,6280)),"@site/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",6280],a3711c17:[()=>n.e(5235).then(n.bind(n,3544)),"@site/docs/how-to/sendfile.md",3544],a485a49d:[()=>n.e(1237).then(n.bind(n,4449)),"@site/docs/reference/structures/Dialog/interfaces/DialogValidation.md",4449],a4a33699:[()=>n.e(8437).then(n.bind(n,2211)),"@site/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",2211],a6aa9e1f:[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(7643)]).then(n.bind(n,5124)),"@theme/BlogListPage",5124],a7456010:[()=>n.e(1235).then(n.t.bind(n,8552,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",8552],a7bd4aaa:[()=>n.e(7098).then(n.bind(n,4532)),"@theme/DocVersionRoot",4532],a8e44dab:[()=>n.e(6262).then(n.bind(n,9225)),"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",9225],a94703ab:[()=>Promise.all([n.e(1869),n.e(9048)]).then(n.bind(n,1377)),"@theme/DocRoot",1377],aba21aa0:[()=>n.e(5742).then(n.t.bind(n,7093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",7093],acb0ea1f:[()=>n.e(7898).then(n.bind(n,7469)),"@site/docs/reference/controllers/init_patch/index.md",7469],acecf23e:[()=>n.e(1903).then(n.t.bind(n,1912,19)),"~blog/default/blogMetadata-default.json",1912],ae1c8c73:[()=>n.e(7492).then(n.bind(n,1388)),"@site/docs/reference/api/model/aliases/type-aliases/Base64.md",1388],af80f1f3:[()=>n.e(9772).then(n.bind(n,7926)),"@site/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",7926],b0030a2c:[()=>n.e(1422).then(n.bind(n,7606)),"@site/docs/reference/api/model/config/interfaces/DevTools.md",7606],b123e85d:[()=>n.e(3605).then(n.bind(n,1224)),"@site/docs/how-to/send-files.md",1224],b182beed:[()=>n.e(4994).then(n.bind(n,8715)),"@site/docs/reference/api/model/config/interfaces/Webhook.md",8715],b27ebe52:[()=>n.e(9457).then(n.bind(n,4763)),"@site/docs/reference/structures/Dialog/index.md",4763],b2cda8ff:[()=>n.e(6785).then(n.bind(n,3794)),"@site/docs/reference/api/model/product/interfaces/CartItem.md",3794],b35003cc:[()=>n.e(1128).then(n.bind(n,6515)),"@site/docs/reference/api/model/contact/interfaces/BizCategory.md",6515],b430c9d2:[()=>n.e(9486).then(n.bind(n,7054)),"@site/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",7054],b4b23ab8:[()=>n.e(7347).then(n.bind(n,429)),"@site/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",429],b7596626:[()=>n.e(8860).then(n.bind(n,9787)),"@site/docs/reference/api/model/contact/interfaces/BusinessHours.md",9787],b764c1e9:[()=>n.e(3370).then(n.bind(n,9635)),"@site/docs/reference/api/model/media/variables/defaultProcessOptions.md",9635],b868a84c:[()=>n.e(143).then(n.bind(n,8245)),"@site/docs/reference/api/model/errors/classes/AddParticipantError.md",8245],b8787afe:[()=>n.e(523).then(n.bind(n,8809)),"@site/docs/get-started/quick-run.md",8809],b898f833:[()=>n.e(6482).then(n.bind(n,4364)),"@site/docs/get-started/docker.md",4364],b8b00aea:[()=>n.e(1831).then(n.bind(n,8326)),"@site/docs/reference/api/model/config/interfaces/EventPayload.md",8326],b998fb11:[()=>n.e(2193).then(n.bind(n,4209)),"@site/docs/reference/structures/Dialog/interfaces/DialogState.md",4209],bb20bb94:[()=>n.e(70).then(n.bind(n,8804)),"@site/docs/reference/api/functions/exposed.enum/index.md",8804],bc6fb640:[()=>n.e(6854).then(n.bind(n,1484)),"@site/docs/reference/api/model/errors/index.md",1484],bd5628fe:[()=>n.e(6909).then(n.bind(n,6713)),"@site/docs/reference/structures/MessageCollector/index.md",6713],be8c3764:[()=>n.e(6611).then(n.bind(n,3170)),"@site/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",3170],c141421f:[()=>n.e(957).then(n.t.bind(n,936,19)),"@generated/docusaurus-theme-search-algolia/default/__plugin.json",936],c15d9823:[()=>n.e(8146).then(n.t.bind(n,9328,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-bd9.json",9328],c1aedf5a:[()=>n.e(9745).then(n.bind(n,1701)),"@site/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",1701],c1f86f2f:[()=>Promise.all([n.e(1869),n.e(9761)]).then(n.bind(n,222)),"@site/docs/configuration/licensed-features.mdx",222],c26b1eba:[()=>n.e(7513).then(n.bind(n,1487)),"@site/docs/reference/logging/logging/index.md",1487],c37329a9:[()=>n.e(4014).then(n.bind(n,7776)),"@site/docs/reference/api/model/message/interfaces/PollData.md",7776],c7b94894:[()=>n.e(2513).then(n.bind(n,6001)),"@site/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",6001],c8a4e95a:[()=>n.e(845).then(n.t.bind(n,1549,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-tutorial-basics-ea4.json",1549],c939f76a:[()=>n.e(8405).then(n.bind(n,6015)),"@site/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",6015],c9540765:[()=>n.e(2484).then(n.bind(n,4819)),"@site/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",4819],cb21221e:[()=>n.e(9969).then(n.bind(n,5017)),"@site/docs/reference/api/model/reactions/index.md",5017],ccc49370:[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(3249)]).then(n.bind(n,3858)),"@theme/BlogPostPage",3858],cce945f2:[()=>n.e(9498).then(n.bind(n,4882)),"@site/docs/reference/api/model/button/interfaces/Button.md",4882],cdd11b4d:[()=>n.e(9306).then(n.bind(n,6153)),"@site/docs/reference/api/model/aliases/type-aliases/MessageId.md",6153],ce48d423:[()=>n.e(9466).then(n.bind(n,6907)),"@site/docs/how-to/react-to-group-events.md",6907],d23fc473:[()=>n.e(5181).then(n.bind(n,2814)),"@site/docs/reference/api/model/message/index.md",2814],d42a3ae7:[()=>n.e(452).then(n.bind(n,2269)),"@site/docs/reference/api/model/message/interfaces/QuoteMap.md",2269],d47ac4be:[()=>n.e(4125).then(n.bind(n,4809)),"@site/docs/reference/api/model/chat/index.md",4809],d58e3925:[()=>n.e(5384).then(n.bind(n,8013)),"@site/docs/how-to/receive-files.md",8013],d6466469:[()=>n.e(1082).then(n.bind(n,9681)),"@site/docs/reference/api/model/sessionInfo/index.md",9681],d88d39d7:[()=>n.e(2848).then(n.bind(n,5744)),"@site/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",5744],d9f32620:[()=>n.e(5557).then(n.bind(n,7447)),"@site/blog/2021-08-26-welcome/index.md",7447],dbe3b6b9:[()=>n.e(5438).then(n.bind(n,7067)),"@site/docs/advanced/best-practices.md",7067],dee01960:[()=>n.e(6629).then(n.bind(n,8382)),"@site/docs/reference/api/model/config/enumerations/NotificationLanguage.md",8382],dff1c289:[()=>n.e(1724).then(n.bind(n,8043)),"@site/docs/tutorial-extras/manage-docs-versions.md",8043],e273c56f:[()=>n.e(9328).then(n.bind(n,4014)),"@site/blog/2019-05-28-first-blog-post.md",4014],e4469e1d:[()=>n.e(5939).then(n.bind(n,4780)),"@site/docs/how-to/read-state.md",4780],e44a2883:[()=>n.e(4736).then(n.bind(n,8350)),"@site/docs/tutorial-extras/translate-your-site.md",8350],e541f69e:[()=>n.e(8394).then(n.bind(n,3688)),"@site/docs/reference/api/model/message/interfaces/Message.md",3688],e5aefb32:[()=>n.e(3276).then(n.t.bind(n,8539,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-facebook-f47.json",8539],e60aee91:[()=>n.e(5003).then(n.bind(n,5782)),"@site/docs/reference/api/model/errors/classes/SessionExpiredError.md",5782],ea673145:[()=>n.e(2081).then(n.bind(n,1163)),"@site/docs/reference/api/model/reactions/type-aliases/Reaction.md",1163],eaab7dd2:[()=>n.e(5451).then(n.bind(n,8839)),"@site/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",8839],eaeca54c:[()=>n.e(9940).then(n.bind(n,7753)),"@site/docs/reference/structures/preProcessors/index.md",7753],ed88e295:[()=>n.e(3371).then(n.bind(n,744)),"@site/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",744],edb57414:[()=>n.e(1425).then(n.bind(n,1777)),"@site/docs/how-to/manage-participants.md",1777],edc18652:[()=>n.e(5107).then(n.bind(n,5257)),"@site/docs/reference/structures/Dialog/enumerations/ValidationType.md",5257],ee112ecc:[()=>n.e(6934).then(n.bind(n,565)),"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",565],ef89b32c:[()=>n.e(4171).then(n.bind(n,7056)),"@site/docs/get-started/link-code.md",7056],ef8b811a:[()=>n.e(8947).then(n.t.bind(n,6600,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-authors-790.json",6600],eff1717c:[()=>n.e(1399).then(n.bind(n,4997)),"@site/docs/reference/api/model/chat/type-aliases/Chat.md",4997],f0def62b:[()=>n.e(9584).then(n.bind(n,720)),"@site/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",720],f1169565:[()=>n.e(2884).then(n.bind(n,3411)),"@site/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",3411],f2171f78:[()=>n.e(6283).then(n.bind(n,1576)),"@site/docs/reference/api/model/message/interfaces/MessageInfo.md",1576],f22ab3cc:[()=>n.e(583).then(n.bind(n,8590)),"@site/docs/reference/structures/Collector/classes/Collector.md",8590],f38ef2c2:[()=>n.e(6052).then(n.bind(n,4500)),"@site/docs/reference/api/Client/variables/useragent.md",4500],f3df8bb0:[()=>n.e(8924).then(n.bind(n,5923)),"@site/docs/reference/api/model/message/enumerations/MessageAck.md",5923],f3fdb01a:[()=>n.e(52).then(n.bind(n,5255)),"@site/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",5255],f47e5abf:[()=>n.e(1619).then(n.bind(n,9601)),"@site/docs/reference/api/model/call/enumerations/CallState.md",9601],f4e478b9:[()=>n.e(5136).then(n.bind(n,2399)),"@site/docs/reference/api/model/message/interfaces/PollOption.md",2399],f4f34a3a:[()=>n.e(3637).then(n.bind(n,5512)),"@site/blog/2021-08-01-mdx-blog-post.mdx?truncated=true",5512],f55d3e7a:[()=>n.e(8863).then(n.bind(n,745)),"@site/docs/tutorial-basics/deploy-your-site.md",745],f5760147:[()=>n.e(4941).then(n.bind(n,9557)),"@site/docs/reference/api/model/aliases/index.md",9557],f81c1134:[()=>n.e(8130).then(n.t.bind(n,7735,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-archive-f05.json",7735],f82cd581:[()=>n.e(4584).then(n.t.bind(n,4035,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hello-f96.json",4035],fb1af417:[()=>n.e(6463).then(n.bind(n,4431)),"@site/docs/reference/api/model/type-aliases/EasyApiResponse.md",4431],fb5cf5eb:[()=>n.e(7569).then(n.bind(n,2344)),"@site/docs/reference/api/model/errors/classes/CustomError.md",2344],fbf304ed:[()=>n.e(4453).then(n.bind(n,1339)),"@site/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",1339],fc7d6c3b:[()=>n.e(8629).then(n.bind(n,855)),"@site/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",855],fd96faf0:[()=>n.e(4113).then(n.bind(n,877)),"@site/docs/reference/structures/Collector/classes/Collection.md",877],ffc4ade8:[()=>n.e(9094).then(n.bind(n,9100)),"@site/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",9100]};var s=n(4848);function l(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(6921),u=n(3102);function d(e,t){if("*"===e)return o()({loading:l,loader:()=>n.e(2237).then(n.bind(n,2237)),modules:["@theme/NotFound"],webpack:()=>[2237],render(e,t){const n=e.default;return(0,s.jsx)(u.W,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},p=[],f=[],m=(0,c.A)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),o().Map({loading:l,loader:d,modules:p,webpack:()=>f,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const s=n.split(".");s.slice(0,-1).forEach((e=>{i=i[e]})),i[s[s.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;delete o.__context;const l=o.__props;return delete o.__props,(0,s.jsx)(u.W,{value:i,children:(0,s.jsx)(a,{...o,...l,...n})})}})}const p=[{path:"/blog",component:d("/blog","b2f"),exact:!0},{path:"/blog/archive",component:d("/blog/archive","182"),exact:!0},{path:"/blog/authors",component:d("/blog/authors","0b7"),exact:!0},{path:"/blog/first-blog-post",component:d("/blog/first-blog-post","89a"),exact:!0},{path:"/blog/long-blog-post",component:d("/blog/long-blog-post","9ad"),exact:!0},{path:"/blog/mdx-blog-post",component:d("/blog/mdx-blog-post","e9f"),exact:!0},{path:"/blog/tags",component:d("/blog/tags","287"),exact:!0},{path:"/blog/tags/docusaurus",component:d("/blog/tags/docusaurus","704"),exact:!0},{path:"/blog/tags/facebook",component:d("/blog/tags/facebook","858"),exact:!0},{path:"/blog/tags/hello",component:d("/blog/tags/hello","299"),exact:!0},{path:"/blog/tags/hola",component:d("/blog/tags/hola","00d"),exact:!0},{path:"/blog/welcome",component:d("/blog/welcome","d2b"),exact:!0},{path:"/markdown-page",component:d("/markdown-page","3d7"),exact:!0},{path:"/search",component:d("/search","5de"),exact:!0},{path:"/docs",component:d("/docs","925"),routes:[{path:"/docs",component:d("/docs","a90"),routes:[{path:"/docs",component:d("/docs","2e8"),routes:[{path:"/docs/advanced/best-practices",component:d("/docs/advanced/best-practices","c77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api",component:d("/docs/api","413"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/tutorial---basics",component:d("/docs/category/tutorial---basics","20e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/tutorial---extras",component:d("/docs/category/tutorial---extras","9ad"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/concepts/glossary",component:d("/docs/concepts/glossary","26c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/concepts/how-it-works",component:d("/docs/concepts/how-it-works","132"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/capture-qr",component:d("/docs/configuration/capture-qr","4b7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/capture-sd",component:d("/docs/configuration/capture-sd","68c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/command-line-options",component:d("/docs/configuration/command-line-options","af5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/config-object",component:d("/docs/configuration/config-object","e5f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/launch-events",component:d("/docs/configuration/launch-events","ae2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/licensed-features",component:d("/docs/configuration/licensed-features","156"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/multiple-sessions",component:d("/docs/configuration/multiple-sessions","bd5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/the-client",component:d("/docs/configuration/the-client","b63"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/docker",component:d("/docs/get-started/docker","f9c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/installation",component:d("/docs/get-started/installation","1f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/link-code",component:d("/docs/get-started/link-code","487"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/quick-run",component:d("/docs/get-started/quick-run","f44"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/socketmode",component:d("/docs/get-started/socketmode","0bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/create-api",component:d("/docs/how-to/create-api","c92"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/decrypt-media",component:d("/docs/how-to/decrypt-media","c3b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/detect-logout",component:d("/docs/how-to/detect-logout","a71"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/groups",component:d("/docs/how-to/groups","b6d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/handle-errors",component:d("/docs/how-to/handle-errors","6d4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/incoming-calls",component:d("/docs/how-to/incoming-calls","c9e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/location",component:d("/docs/how-to/location","9cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/manage-participants",component:d("/docs/how-to/manage-participants","524"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/misc",component:d("/docs/how-to/misc","12d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/react-to-group-events",component:d("/docs/how-to/react-to-group-events","228"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/read-state",component:d("/docs/how-to/read-state","257"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/receive-files",component:d("/docs/how-to/receive-files","442"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/receive-messages",component:d("/docs/how-to/receive-messages","4cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-files",component:d("/docs/how-to/send-files","c77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-messages",component:d("/docs/how-to/send-messages","d8c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-videos",component:d("/docs/how-to/send-videos","401"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/sendfile",component:d("/docs/how-to/sendfile","ce3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/use-a-proxy",component:d("/docs/how-to/use-a-proxy","3a3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/Integrations/chatwoot",component:d("/docs/Integrations/chatwoot","757"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/intro",component:d("/docs/intro","61d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference",component:d("/docs/reference","435"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client",component:d("/docs/reference/api/Client","f1f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/classes/Client",component:d("/docs/reference/api/Client/classes/Client","2e0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/enumerations/namespace",component:d("/docs/reference/api/Client/enumerations/namespace","1d2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/variables/useragent",component:d("/docs/reference/api/Client/variables/useragent","177"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/functions/exposed.enum",component:d("/docs/reference/api/functions/exposed.enum","d93"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",component:d("/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","136"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model",component:d("/docs/reference/api/model","35e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases",component:d("/docs/reference/api/model/aliases","2c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",component:d("/docs/reference/api/model/aliases/type-aliases/AccountNumber","29d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",component:d("/docs/reference/api/model/aliases/type-aliases/AdvancedFile","f39"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/Base64",component:d("/docs/reference/api/model/aliases/type-aliases/Base64","88b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ChatId",component:d("/docs/reference/api/model/aliases/type-aliases/ChatId","07b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ChatServer",component:d("/docs/reference/api/model/aliases/type-aliases/ChatServer","2bc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ContactId",component:d("/docs/reference/api/model/aliases/type-aliases/ContactId","5c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/Content",component:d("/docs/reference/api/model/aliases/type-aliases/Content","677"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/CountryCode",component:d("/docs/reference/api/model/aliases/type-aliases/CountryCode","877"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/DataURL",component:d("/docs/reference/api/model/aliases/type-aliases/DataURL","f87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/FilePath",component:d("/docs/reference/api/model/aliases/type-aliases/FilePath","170"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GetURL",component:d("/docs/reference/api/model/aliases/type-aliases/GetURL","dee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",component:d("/docs/reference/api/model/aliases/type-aliases/GroupChatId","ba5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",component:d("/docs/reference/api/model/aliases/type-aliases/GroupChatServer","b7f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupId",component:d("/docs/reference/api/model/aliases/type-aliases/GroupId","6be"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/MessageId",component:d("/docs/reference/api/model/aliases/type-aliases/MessageId","bcb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",component:d("/docs/reference/api/model/aliases/type-aliases/NonSerializedId","88f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/WaServers",component:d("/docs/reference/api/model/aliases/type-aliases/WaServers","85c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button",component:d("/docs/reference/api/model/button","8b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/AdvancedButton",component:d("/docs/reference/api/model/button/interfaces/AdvancedButton","200"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Button",component:d("/docs/reference/api/model/button/interfaces/Button","2bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/LocationButtonBody",component:d("/docs/reference/api/model/button/interfaces/LocationButtonBody","2a4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Row",component:d("/docs/reference/api/model/button/interfaces/Row","cee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Section",component:d("/docs/reference/api/model/button/interfaces/Section","59d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call",component:d("/docs/reference/api/model/call","7dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call/enumerations/CallState",component:d("/docs/reference/api/model/call/enumerations/CallState","5f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call/interfaces/Call",component:d("/docs/reference/api/model/call/interfaces/Call","750"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat",component:d("/docs/reference/api/model/chat","fbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",component:d("/docs/reference/api/model/chat/enumerations/ChatMuteDuration","b94"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatState",component:d("/docs/reference/api/model/chat/enumerations/ChatState","7b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatTypes",component:d("/docs/reference/api/model/chat/enumerations/ChatTypes","868"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/BaseChat",component:d("/docs/reference/api/model/chat/interfaces/BaseChat","ee6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChat",component:d("/docs/reference/api/model/chat/interfaces/GroupChat","70d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",component:d("/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","728"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",component:d("/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","8dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",component:d("/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","bff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/SingleChat",component:d("/docs/reference/api/model/chat/interfaces/SingleChat","f62"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/type-aliases/Chat",component:d("/docs/reference/api/model/chat/type-aliases/Chat","b2c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",component:d("/docs/reference/api/model/chat/type-aliases/EphemeralDuration","2a9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config",component:d("/docs/reference/api/model/config","953"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",component:d("/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","a85"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",component:d("/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","a95"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/LicenseType",component:d("/docs/reference/api/model/config/enumerations/LicenseType","8cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/NotificationLanguage",component:d("/docs/reference/api/model/config/enumerations/NotificationLanguage","fb6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/OnError",component:d("/docs/reference/api/model/config/enumerations/OnError","6f7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/QRFormat",component:d("/docs/reference/api/model/config/enumerations/QRFormat","ad5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/QRQuality",component:d("/docs/reference/api/model/config/enumerations/QRQuality","62f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/ConfigObject",component:d("/docs/reference/api/model/config/interfaces/ConfigObject","316"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/DevTools",component:d("/docs/reference/api/model/config/interfaces/DevTools","c6d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/EventPayload",component:d("/docs/reference/api/model/config/interfaces/EventPayload","148"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",component:d("/docs/reference/api/model/config/interfaces/ProxyServerCredentials","0d7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/SessionData",component:d("/docs/reference/api/model/config/interfaces/SessionData","f70"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/Webhook",component:d("/docs/reference/api/model/config/interfaces/Webhook","ca0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",component:d("/docs/reference/api/model/config/type-aliases/AdvancedConfig","662"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact",component:d("/docs/reference/api/model/contact","b83"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BizCategory",component:d("/docs/reference/api/model/contact/interfaces/BizCategory","0f0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",component:d("/docs/reference/api/model/contact/interfaces/BizProfileOptions","931"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BusinessHours",component:d("/docs/reference/api/model/contact/interfaces/BusinessHours","000"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BusinessProfile",component:d("/docs/reference/api/model/contact/interfaces/BusinessProfile","47f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/Contact",component:d("/docs/reference/api/model/contact/interfaces/Contact","ed7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/NumberCheck",component:d("/docs/reference/api/model/contact/interfaces/NumberCheck","ee0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/Events",component:d("/docs/reference/api/model/enumerations/Events","783"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/STATE",component:d("/docs/reference/api/model/enumerations/STATE","30f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/Status",component:d("/docs/reference/api/model/enumerations/Status","674"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors",component:d("/docs/reference/api/model/errors","95c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/AddParticipantError",component:d("/docs/reference/api/model/errors/classes/AddParticipantError","656"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/CustomError",component:d("/docs/reference/api/model/errors/classes/CustomError","2cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",component:d("/docs/reference/api/model/errors/classes/PageEvaluationTimeout","71f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/SessionExpiredError",component:d("/docs/reference/api/model/errors/classes/SessionExpiredError","f24"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",component:d("/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","b86"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",component:d("/docs/reference/api/model/errors/enumerations/ERROR_NAME","766"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/events",component:d("/docs/reference/api/model/events","9b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/events/enumerations/SimpleListener",component:d("/docs/reference/api/model/events/enumerations/SimpleListener","6c8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata",component:d("/docs/reference/api/model/group-metadata","48c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",component:d("/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","b4d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",component:d("/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","708"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",component:d("/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","8c1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",component:d("/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","63a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",component:d("/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","93b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/Participant",component:d("/docs/reference/api/model/group-metadata/interfaces/Participant","f4c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",component:d("/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","fc7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/id",component:d("/docs/reference/api/model/id","f45"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/id/interfaces/Id",component:d("/docs/reference/api/model/id/interfaces/Id","1cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/label",component:d("/docs/reference/api/model/label","aaf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/label/interfaces/Label",component:d("/docs/reference/api/model/label/interfaces/Label","174"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media",component:d("/docs/reference/api/model/media","d9b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",component:d("/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","440"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/type-aliases/StickerMetadata",component:d("/docs/reference/api/model/media/type-aliases/StickerMetadata","b41"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/variables/defaultProcessOptions",component:d("/docs/reference/api/model/media/variables/defaultProcessOptions","763"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message",component:d("/docs/reference/api/model/message","b95"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/enumerations/MessageAck",component:d("/docs/reference/api/model/message/enumerations/MessageAck","a6b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/enumerations/MessageTypes",component:d("/docs/reference/api/model/message/enumerations/MessageTypes","1ed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/Message",component:d("/docs/reference/api/model/message/interfaces/Message","cb9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/MessageInfo",component:d("/docs/reference/api/model/message/interfaces/MessageInfo","b09"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",component:d("/docs/reference/api/model/message/interfaces/MessageInfoInteraction","f60"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollData",component:d("/docs/reference/api/model/message/interfaces/PollData","2ac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollOption",component:d("/docs/reference/api/model/message/interfaces/PollOption","9b4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollVote",component:d("/docs/reference/api/model/message/interfaces/PollVote","1c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/QuoteMap",component:d("/docs/reference/api/model/message/interfaces/QuoteMap","085"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/ReactionSender",component:d("/docs/reference/api/model/message/interfaces/ReactionSender","80a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product",component:d("/docs/reference/api/model/product","c66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/CartItem",component:d("/docs/reference/api/model/product/interfaces/CartItem","e69"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/CustomProduct",component:d("/docs/reference/api/model/product/interfaces/CustomProduct","9f8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/Order",component:d("/docs/reference/api/model/product/interfaces/Order","2ba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/Product",component:d("/docs/reference/api/model/product/interfaces/Product","aba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions",component:d("/docs/reference/api/model/reactions","b2c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/Reaction",component:d("/docs/reference/api/model/reactions/type-aliases/Reaction","2ba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",component:d("/docs/reference/api/model/reactions/type-aliases/ReactionEvent","fe2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",component:d("/docs/reference/api/model/reactions/type-aliases/ReactionRecord","540"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo",component:d("/docs/reference/api/model/sessionInfo","fbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",component:d("/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","9cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",component:d("/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","e1a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/type-aliases/EasyApiResponse",component:d("/docs/reference/api/model/type-aliases/EasyApiResponse","cc5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/events",component:d("/docs/reference/controllers/events","d66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/events/variables/ev",component:d("/docs/reference/controllers/events/variables/ev","2a1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/init_patch",component:d("/docs/reference/controllers/init_patch","461"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer",component:d("/docs/reference/controllers/initializer","a51"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/functions/create",component:d("/docs/reference/controllers/initializer/functions/create","102"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/functions/timeout",component:d("/docs/reference/controllers/initializer/functions/timeout","627"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/configWithCases",component:d("/docs/reference/controllers/initializer/variables/configWithCases","491"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/pkg",component:d("/docs/reference/controllers/initializer/variables/pkg","31d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/screenshot",component:d("/docs/reference/controllers/initializer/variables/screenshot","9d8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager",component:d("/docs/reference/controllers/patch_manager","8d8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",component:d("/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","225"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",component:d("/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","587"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport",component:d("/docs/reference/logging/custom_transport","130"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",component:d("/docs/reference/logging/custom_transport/classes/LogToEvTransport","e50"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport/classes/NoOpTransport",component:d("/docs/reference/logging/custom_transport/classes/NoOpTransport","47d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging",component:d("/docs/reference/logging/logging","2a1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",component:d("/docs/reference/logging/logging/functions/addRotateFileLogTransport","251"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",component:d("/docs/reference/logging/logging/type-aliases/ConfigLogTransport","b0a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/variables/log",component:d("/docs/reference/logging/logging/variables/log","54d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector",component:d("/docs/reference/structures/Collector","3e4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/classes/Collection",component:d("/docs/reference/structures/Collector/classes/Collection","4a5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/classes/Collector",component:d("/docs/reference/structures/Collector/classes/Collector","38e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",component:d("/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","a21"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/interfaces/CollectorOptions",component:d("/docs/reference/structures/Collector/interfaces/CollectorOptions","5c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",component:d("/docs/reference/structures/Collector/type-aliases/CollectorFilter","a25"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog",component:d("/docs/reference/structures/Dialog","86b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/enumerations/ValidationType",component:d("/docs/reference/structures/Dialog/enumerations/ValidationType","3ea"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",component:d("/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","7d0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogButtons",component:d("/docs/reference/structures/Dialog/interfaces/DialogButtons","96d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",component:d("/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","8d3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",component:d("/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","13a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogProperty",component:d("/docs/reference/structures/Dialog/interfaces/DialogProperty","602"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogState",component:d("/docs/reference/structures/Dialog/interfaces/DialogState","cc0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",component:d("/docs/reference/structures/Dialog/interfaces/DialogTemplate","65b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogValidation",component:d("/docs/reference/structures/Dialog/interfaces/DialogValidation","634"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",component:d("/docs/reference/structures/Dialog/type-aliases/CheckFunction","c68"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/MessageCollector",component:d("/docs/reference/structures/MessageCollector","36d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/MessageCollector/classes/MessageCollector",component:d("/docs/reference/structures/MessageCollector/classes/MessageCollector","009"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors",component:d("/docs/reference/structures/preProcessors","396"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",component:d("/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","530"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",component:d("/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","396"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",component:d("/docs/reference/structures/preProcessors/type-aliases/MPConfigType","9b2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",component:d("/docs/reference/structures/preProcessors/variables/MessagePreprocessors","4dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/congratulations",component:d("/docs/tutorial-basics/congratulations","458"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-blog-post",component:d("/docs/tutorial-basics/create-a-blog-post","108"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-document",component:d("/docs/tutorial-basics/create-a-document","8fc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-page",component:d("/docs/tutorial-basics/create-a-page","951"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/deploy-your-site",component:d("/docs/tutorial-basics/deploy-your-site","4f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/markdown-features",component:d("/docs/tutorial-basics/markdown-features","b05"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-extras/manage-docs-versions",component:d("/docs/tutorial-extras/manage-docs-versions","978"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-extras/translate-your-site",component:d("/docs/tutorial-extras/translate-your-site","f9a"),exact:!0,sidebar:"tutorialSidebar"}]}]}]},{path:"/",component:d("/","e5f"),exact:!0},{path:"*",component:d("*")}]},6125:(e,t,n)=>{"use strict";n.d(t,{o:()=>a,x:()=>i});var r=n(6540),o=n(4848);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},8536:(e,t,n)=>{"use strict";var r=n(6540),o=n(5338),a=n(545),i=n(4625),s=n(4784),l=n(8193);const c=[n(119),n(6134),n(6294),n(1043),n(9530)];var u=n(8328),d=n(6347),p=n(2831),f=n(4848);function m(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var h=n(5260),g=n(4586),b=n(6025),y=n(6342),v=n(5500),w=n(2131),S=n(4090),k=n(2967),x=n(440),_=n(1463);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.A)(),r=(0,w.o)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(h.A,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.A)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.A)(),{pathname:r}=(0,d.zy)();return e+(0,x.Ks)((0,b.Ay)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{property:"og:url",content:o}),(0,f.jsx)("link",{rel:"canonical",href:o})]})}function O(){const{i18n:{currentLocale:e}}=(0,g.A)(),{metadata:t,image:n}=(0,y.p)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:S.w})]}),n&&(0,f.jsx)(v.be,{image:n}),(0,f.jsx)(C,{}),(0,f.jsx)(E,{}),(0,f.jsx)(_.A,{tag:k.C,locale:e}),(0,f.jsx)(h.A,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const P=new Map;var T=n(6125),A=n(6988),j=n(205);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>o.forEach((e=>e?.()))}const I=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,j.A)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,o=t.hash===n.hash,a=t.search===n.search;if(r&&o&&!a)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),R("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function D(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,p.u)(u.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class L extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.A.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),D(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,f.jsx)(I,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(d.qh,{location:t,render:()=>e})})}}const N=L,M="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",B="__docusaurus-base-url-issue-banner-suggestion-container";function z(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{let{route:t}=e;return!0===t.exact})))return P.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return P.set(e.pathname,t),{...e,pathname:t}}((0,d.zy)());return(0,f.jsx)(N,{location:e,children:W})}function Q(){return(0,f.jsx)(H.A,{children:(0,f.jsx)(A.l,{children:(0,f.jsxs)(T.x,{children:[(0,f.jsxs)(m,{children:[(0,f.jsx)(q,{}),(0,f.jsx)(O,{}),(0,f.jsx)($,{}),(0,f.jsx)(K,{})]}),(0,f.jsx)(V,{})]})})})}var Y=n(4054);const Z=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var J=n(6921);const X=new Set,ee=new Set,te=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ne={prefetch:e=>{if(!(e=>!te()&&!ee.has(e)&&!X.has(e))(e))return!1;X.add(e);const t=(0,p.u)(u.A,e).flatMap((e=>{return t=e.route.path,Object.entries(Y).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,J.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Z(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!te()&&!ee.has(e))(e)&&(ee.add(e),D(e))},re=Object.freeze(ne);function oe(e){let{children:t}=e;return"hash"===s.default.future.experimental_router?(0,f.jsx)(i.I9,{children:t}):(0,f.jsx)(i.Kd,{children:t})}const ae=Boolean(!0);if(l.A.canUseDOM){window.docusaurus=re;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(a.vd,{children:(0,f.jsx)(oe,{children:(0,f.jsx)(Q,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},i=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(ae)window.docusaurusRoot=o.hydrateRoot(e,t,{onRecoverableError:n});else{const r=o.createRoot(e,{onRecoverableError:n});r.render(t),window.docusaurusRoot=r}};D(window.location.pathname).then((()=>{(0,r.startTransition)(i)}))}},6988:(e,t,n)=>{"use strict";n.d(t,{o:()=>d,l:()=>p});var r=n(6540),o=n(4784);const a=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"intro","docs":[{"id":"advanced/best-practices","path":"/docs/advanced/best-practices","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/docs/api/","sidebar":"tutorialSidebar"},{"id":"concepts/glossary","path":"/docs/concepts/glossary","sidebar":"tutorialSidebar"},{"id":"concepts/how-it-works","path":"/docs/concepts/how-it-works","sidebar":"tutorialSidebar"},{"id":"configuration/capture-qr","path":"/docs/configuration/capture-qr","sidebar":"tutorialSidebar"},{"id":"configuration/capture-sd","path":"/docs/configuration/capture-sd","sidebar":"tutorialSidebar"},{"id":"configuration/command-line-options","path":"/docs/configuration/command-line-options","sidebar":"tutorialSidebar"},{"id":"configuration/config-object","path":"/docs/configuration/config-object","sidebar":"tutorialSidebar"},{"id":"configuration/launch-events","path":"/docs/configuration/launch-events","sidebar":"tutorialSidebar"},{"id":"configuration/licensed-features","path":"/docs/configuration/licensed-features","sidebar":"tutorialSidebar"},{"id":"configuration/multiple-sessions","path":"/docs/configuration/multiple-sessions","sidebar":"tutorialSidebar"},{"id":"configuration/the-client","path":"/docs/configuration/the-client","sidebar":"tutorialSidebar"},{"id":"get-started/docker","path":"/docs/get-started/docker","sidebar":"tutorialSidebar"},{"id":"get-started/installation","path":"/docs/get-started/installation","sidebar":"tutorialSidebar"},{"id":"get-started/link-code","path":"/docs/get-started/link-code","sidebar":"tutorialSidebar"},{"id":"get-started/quick-run","path":"/docs/get-started/quick-run","sidebar":"tutorialSidebar"},{"id":"get-started/socketmode","path":"/docs/get-started/socketmode","sidebar":"tutorialSidebar"},{"id":"how-to/create-api","path":"/docs/how-to/create-api","sidebar":"tutorialSidebar"},{"id":"how-to/decrypt-media","path":"/docs/how-to/decrypt-media","sidebar":"tutorialSidebar"},{"id":"how-to/detect-logout","path":"/docs/how-to/detect-logout","sidebar":"tutorialSidebar"},{"id":"how-to/groups","path":"/docs/how-to/groups","sidebar":"tutorialSidebar"},{"id":"how-to/handle-errors","path":"/docs/how-to/handle-errors","sidebar":"tutorialSidebar"},{"id":"how-to/incoming-calls","path":"/docs/how-to/incoming-calls","sidebar":"tutorialSidebar"},{"id":"how-to/location","path":"/docs/how-to/location","sidebar":"tutorialSidebar"},{"id":"how-to/manage-participants","path":"/docs/how-to/manage-participants","sidebar":"tutorialSidebar"},{"id":"how-to/misc","path":"/docs/how-to/misc","sidebar":"tutorialSidebar"},{"id":"how-to/react-to-group-events","path":"/docs/how-to/react-to-group-events","sidebar":"tutorialSidebar"},{"id":"how-to/read-state","path":"/docs/how-to/read-state","sidebar":"tutorialSidebar"},{"id":"how-to/receive-files","path":"/docs/how-to/receive-files","sidebar":"tutorialSidebar"},{"id":"how-to/receive-messages","path":"/docs/how-to/receive-messages","sidebar":"tutorialSidebar"},{"id":"how-to/send-files","path":"/docs/how-to/send-files","sidebar":"tutorialSidebar"},{"id":"how-to/send-messages","path":"/docs/how-to/send-messages","sidebar":"tutorialSidebar"},{"id":"how-to/send-videos","path":"/docs/how-to/send-videos","sidebar":"tutorialSidebar"},{"id":"how-to/sendfile","path":"/docs/how-to/sendfile","sidebar":"tutorialSidebar"},{"id":"how-to/use-a-proxy","path":"/docs/how-to/use-a-proxy","sidebar":"tutorialSidebar"},{"id":"Integrations/chatwoot","path":"/docs/Integrations/chatwoot","sidebar":"tutorialSidebar"},{"id":"intro","path":"/docs/intro","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/classes/Client","path":"/docs/reference/api/Client/classes/Client","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/enumerations/namespace","path":"/docs/reference/api/Client/enumerations/namespace","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/index","path":"/docs/reference/api/Client/","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/variables/useragent","path":"/docs/reference/api/Client/variables/useragent","sidebar":"tutorialSidebar"},{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","path":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","sidebar":"tutorialSidebar"},{"id":"reference/api/functions/exposed.enum/index","path":"/docs/reference/api/functions/exposed.enum/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/index","path":"/docs/reference/api/model/aliases/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/AccountNumber","path":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","path":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/Base64","path":"/docs/reference/api/model/aliases/type-aliases/Base64","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ChatId","path":"/docs/reference/api/model/aliases/type-aliases/ChatId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ChatServer","path":"/docs/reference/api/model/aliases/type-aliases/ChatServer","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ContactId","path":"/docs/reference/api/model/aliases/type-aliases/ContactId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/Content","path":"/docs/reference/api/model/aliases/type-aliases/Content","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/CountryCode","path":"/docs/reference/api/model/aliases/type-aliases/CountryCode","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/DataURL","path":"/docs/reference/api/model/aliases/type-aliases/DataURL","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/FilePath","path":"/docs/reference/api/model/aliases/type-aliases/FilePath","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GetURL","path":"/docs/reference/api/model/aliases/type-aliases/GetURL","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupChatId","path":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","path":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupId","path":"/docs/reference/api/model/aliases/type-aliases/GroupId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/MessageId","path":"/docs/reference/api/model/aliases/type-aliases/MessageId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","path":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/WaServers","path":"/docs/reference/api/model/aliases/type-aliases/WaServers","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/index","path":"/docs/reference/api/model/button/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/AdvancedButton","path":"/docs/reference/api/model/button/interfaces/AdvancedButton","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Button","path":"/docs/reference/api/model/button/interfaces/Button","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/LocationButtonBody","path":"/docs/reference/api/model/button/interfaces/LocationButtonBody","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Row","path":"/docs/reference/api/model/button/interfaces/Row","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Section","path":"/docs/reference/api/model/button/interfaces/Section","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/enumerations/CallState","path":"/docs/reference/api/model/call/enumerations/CallState","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/index","path":"/docs/reference/api/model/call/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/interfaces/Call","path":"/docs/reference/api/model/call/interfaces/Call","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","path":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatState","path":"/docs/reference/api/model/chat/enumerations/ChatState","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatTypes","path":"/docs/reference/api/model/chat/enumerations/ChatTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/index","path":"/docs/reference/api/model/chat/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/BaseChat","path":"/docs/reference/api/model/chat/interfaces/BaseChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChat","path":"/docs/reference/api/model/chat/interfaces/GroupChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","path":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","path":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","path":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/SingleChat","path":"/docs/reference/api/model/chat/interfaces/SingleChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/type-aliases/Chat","path":"/docs/reference/api/model/chat/type-aliases/Chat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","path":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","path":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","path":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/LicenseType","path":"/docs/reference/api/model/config/enumerations/LicenseType","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/NotificationLanguage","path":"/docs/reference/api/model/config/enumerations/NotificationLanguage","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/OnError","path":"/docs/reference/api/model/config/enumerations/OnError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/QRFormat","path":"/docs/reference/api/model/config/enumerations/QRFormat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/QRQuality","path":"/docs/reference/api/model/config/enumerations/QRQuality","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/index","path":"/docs/reference/api/model/config/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/ConfigObject","path":"/docs/reference/api/model/config/interfaces/ConfigObject","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/DevTools","path":"/docs/reference/api/model/config/interfaces/DevTools","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/EventPayload","path":"/docs/reference/api/model/config/interfaces/EventPayload","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","path":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/SessionData","path":"/docs/reference/api/model/config/interfaces/SessionData","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/Webhook","path":"/docs/reference/api/model/config/interfaces/Webhook","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/type-aliases/AdvancedConfig","path":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/index","path":"/docs/reference/api/model/contact/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BizCategory","path":"/docs/reference/api/model/contact/interfaces/BizCategory","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BizProfileOptions","path":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BusinessHours","path":"/docs/reference/api/model/contact/interfaces/BusinessHours","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BusinessProfile","path":"/docs/reference/api/model/contact/interfaces/BusinessProfile","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/Contact","path":"/docs/reference/api/model/contact/interfaces/Contact","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/NumberCheck","path":"/docs/reference/api/model/contact/interfaces/NumberCheck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/Events","path":"/docs/reference/api/model/enumerations/Events","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/STATE","path":"/docs/reference/api/model/enumerations/STATE","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/Status","path":"/docs/reference/api/model/enumerations/Status","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/AddParticipantError","path":"/docs/reference/api/model/errors/classes/AddParticipantError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/CustomError","path":"/docs/reference/api/model/errors/classes/CustomError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","path":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/SessionExpiredError","path":"/docs/reference/api/model/errors/classes/SessionExpiredError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","path":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/enumerations/ERROR_NAME","path":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/index","path":"/docs/reference/api/model/errors/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/events/enumerations/SimpleListener","path":"/docs/reference/api/model/events/enumerations/SimpleListener","sidebar":"tutorialSidebar"},{"id":"reference/api/model/events/index","path":"/docs/reference/api/model/events/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","path":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","path":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/index","path":"/docs/reference/api/model/group-metadata/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","path":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","path":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","path":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/Participant","path":"/docs/reference/api/model/group-metadata/interfaces/Participant","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","path":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","sidebar":"tutorialSidebar"},{"id":"reference/api/model/id/index","path":"/docs/reference/api/model/id/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/id/interfaces/Id","path":"/docs/reference/api/model/id/interfaces/Id","sidebar":"tutorialSidebar"},{"id":"reference/api/model/index","path":"/docs/reference/api/model/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/label/index","path":"/docs/reference/api/model/label/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/label/interfaces/Label","path":"/docs/reference/api/model/label/interfaces/Label","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/index","path":"/docs/reference/api/model/media/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","path":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/type-aliases/StickerMetadata","path":"/docs/reference/api/model/media/type-aliases/StickerMetadata","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/variables/defaultProcessOptions","path":"/docs/reference/api/model/media/variables/defaultProcessOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/enumerations/MessageAck","path":"/docs/reference/api/model/message/enumerations/MessageAck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/enumerations/MessageTypes","path":"/docs/reference/api/model/message/enumerations/MessageTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/index","path":"/docs/reference/api/model/message/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/Message","path":"/docs/reference/api/model/message/interfaces/Message","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/MessageInfo","path":"/docs/reference/api/model/message/interfaces/MessageInfo","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","path":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollData","path":"/docs/reference/api/model/message/interfaces/PollData","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollOption","path":"/docs/reference/api/model/message/interfaces/PollOption","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollVote","path":"/docs/reference/api/model/message/interfaces/PollVote","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/QuoteMap","path":"/docs/reference/api/model/message/interfaces/QuoteMap","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/ReactionSender","path":"/docs/reference/api/model/message/interfaces/ReactionSender","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/index","path":"/docs/reference/api/model/product/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/CartItem","path":"/docs/reference/api/model/product/interfaces/CartItem","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/CustomProduct","path":"/docs/reference/api/model/product/interfaces/CustomProduct","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/Order","path":"/docs/reference/api/model/product/interfaces/Order","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/Product","path":"/docs/reference/api/model/product/interfaces/Product","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/index","path":"/docs/reference/api/model/reactions/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/Reaction","path":"/docs/reference/api/model/reactions/type-aliases/Reaction","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","path":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","path":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/index","path":"/docs/reference/api/model/sessionInfo/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","path":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","path":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","sidebar":"tutorialSidebar"},{"id":"reference/api/model/type-aliases/EasyApiResponse","path":"/docs/reference/api/model/type-aliases/EasyApiResponse","sidebar":"tutorialSidebar"},{"id":"reference/controllers/events/index","path":"/docs/reference/controllers/events/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/events/variables/ev","path":"/docs/reference/controllers/events/variables/ev","sidebar":"tutorialSidebar"},{"id":"reference/controllers/init_patch/index","path":"/docs/reference/controllers/init_patch/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/functions/create","path":"/docs/reference/controllers/initializer/functions/create","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/functions/timeout","path":"/docs/reference/controllers/initializer/functions/timeout","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/index","path":"/docs/reference/controllers/initializer/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/configWithCases","path":"/docs/reference/controllers/initializer/variables/configWithCases","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/pkg","path":"/docs/reference/controllers/initializer/variables/pkg","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/screenshot","path":"/docs/reference/controllers/initializer/variables/screenshot","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","path":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","path":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/index","path":"/docs/reference/controllers/patch_manager/","sidebar":"tutorialSidebar"},{"id":"reference/index","path":"/docs/reference/","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/classes/LogToEvTransport","path":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/classes/NoOpTransport","path":"/docs/reference/logging/custom_transport/classes/NoOpTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/index","path":"/docs/reference/logging/custom_transport/","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/functions/addRotateFileLogTransport","path":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/index","path":"/docs/reference/logging/logging/","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","path":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/variables/log","path":"/docs/reference/logging/logging/variables/log","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/classes/Collection","path":"/docs/reference/structures/Collector/classes/Collection","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/classes/Collector","path":"/docs/reference/structures/Collector/classes/Collector","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/index","path":"/docs/reference/structures/Collector/","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","path":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/interfaces/CollectorOptions","path":"/docs/reference/structures/Collector/interfaces/CollectorOptions","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/type-aliases/CollectorFilter","path":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/enumerations/ValidationType","path":"/docs/reference/structures/Dialog/enumerations/ValidationType","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/index","path":"/docs/reference/structures/Dialog/","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","path":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogButtons","path":"/docs/reference/structures/Dialog/interfaces/DialogButtons","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","path":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","path":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogProperty","path":"/docs/reference/structures/Dialog/interfaces/DialogProperty","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogState","path":"/docs/reference/structures/Dialog/interfaces/DialogState","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogTemplate","path":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogValidation","path":"/docs/reference/structures/Dialog/interfaces/DialogValidation","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/type-aliases/CheckFunction","path":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","sidebar":"tutorialSidebar"},{"id":"reference/structures/MessageCollector/classes/MessageCollector","path":"/docs/reference/structures/MessageCollector/classes/MessageCollector","sidebar":"tutorialSidebar"},{"id":"reference/structures/MessageCollector/index","path":"/docs/reference/structures/MessageCollector/","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","path":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/index","path":"/docs/reference/structures/preProcessors/","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","path":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","path":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","path":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/congratulations","path":"/docs/tutorial-basics/congratulations","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-blog-post","path":"/docs/tutorial-basics/create-a-blog-post","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-document","path":"/docs/tutorial-basics/create-a-document","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-page","path":"/docs/tutorial-basics/create-a-page","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/deploy-your-site","path":"/docs/tutorial-basics/deploy-your-site","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/markdown-features","path":"/docs/tutorial-basics/markdown-features","sidebar":"tutorialSidebar"},{"id":"tutorial-extras/manage-docs-versions","path":"/docs/tutorial-extras/manage-docs-versions","sidebar":"tutorialSidebar"},{"id":"tutorial-extras/translate-your-site","path":"/docs/tutorial-extras/translate-your-site","sidebar":"tutorialSidebar"},{"id":"/category/tutorial---basics","path":"/docs/category/tutorial---basics","sidebar":"tutorialSidebar"},{"id":"/category/tutorial---extras","path":"/docs/category/tutorial---extras","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/intro","label":"intro"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(2654);const l=JSON.parse('{"docusaurusVersion":"3.5.2","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.5.2"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.5.2"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.5.2"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.5.2"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.5.2"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"3.5.2"},"posthog-docusaurus":{"type":"package","name":"posthog-docusaurus","version":"2.0.1"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"1.0.3"},"md-placeholder-replacer":{"type":"local"},"tailwind-plugin":{"type":"local"}}}');var c=n(4848);const u={siteConfig:o.default,siteMetadata:l,globalData:a,i18n:i,codeTranslations:s},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},7489:(e,t,n)=>{"use strict";n.d(t,{A:()=>h});var r=n(6540),o=n(8193),a=n(5260),i=n(440),s=n(3277),l=n(3102),c=n(4848);function u(e){let{error:t,tryAgain:n}=e;return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,c.jsx)(l.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)(p,{children:(0,c.jsxs)(h,{fallback:()=>(0,c.jsx)(u,{error:t,tryAgain:n}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(s.A,{children:(0,c.jsx)(u,{error:t,tryAgain:n})})]})})}const m=e=>(0,c.jsx)(f,{...e});class h extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.A.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},8193:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5260:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(545),o=n(4848);function a(e){return(0,o.jsx)(r.mg,{...e})}},8774:(e,t,n)=>{"use strict";n.d(t,{A:()=>f});var r=n(6540),o=n(4625),a=n(440),i=n(4586),s=n(6654),l=n(8193),c=n(3427),u=n(6025),d=n(4848);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":g,autoAddBaseUrl:b=!0,...y}=e;const{siteConfig:v}=(0,i.A)(),{trailingSlash:w,baseUrl:S}=v,k=v.future.experimental_router,{withBaseUrl:x}=(0,u.hH)(),_=(0,c.A)(),E=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>E.current));const C=p||f;const O=(0,s.A)(C),P=C?.replace("pathname://","");let T=void 0!==P?(A=P,b&&(e=>e.startsWith("/"))(A)?x(A):A):void 0;var A;"hash"===k&&T?.startsWith("./")&&(T=T?.slice(1)),T&&O&&(T=(0,a.Ks)(T,{trailingSlash:w,baseUrl:S}));const j=(0,r.useRef)(!1),R=n?o.k2:o.N_,I=l.A.canUseIntersectionObserver,D=(0,r.useRef)(),L=()=>{j.current||null==T||(window.docusaurus.preload(T),j.current=!0)};(0,r.useEffect)((()=>(!I&&O&&l.A.canUseDOM&&null!=T&&window.docusaurus.prefetch(T),()=>{I&&D.current&&D.current.disconnect()})),[D,T,I,O]);const N=T?.startsWith("#")??!1,M=!y.target||"_self"===y.target,F=!T||!O||!M||N&&"hash"!==k;g||!N&&F||_.collectLink(T),y.id&&_.collectAnchor(y.id);const B={};return F?(0,d.jsx)("a",{ref:E,href:T,...C&&!O&&{target:"_blank",rel:"noopener noreferrer"},...y,...B}):(0,d.jsx)(R,{...y,onMouseEnter:L,onTouchStart:L,innerRef:e=>{E.current=e,I&&e&&O&&(D.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(D.current.unobserve(e),D.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),D.current.observe(e))},to:T,...n&&{isActive:h,activeClassName:m},...B})}const f=r.forwardRef(p)},1312:(e,t,n)=>{"use strict";n.d(t,{A:()=>c,T:()=>l});var r=n(6540),o=n(4848);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(2654);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function l(e,t){let{message:n,id:r}=e;return a(s({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=s({message:t,id:n});return(0,o.jsx)(o.Fragment,{children:a(i,r)})}},7065:(e,t,n)=>{"use strict";n.d(t,{W:()=>r});const r="default"},6654:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{A:()=>o,z:()=>r})},6025:(e,t,n)=>{"use strict";n.d(t,{Ay:()=>s,hH:()=>i});var r=n(6540),o=n(4586),a=n(6654);function i(){const{siteConfig:e}=(0,o.A)(),{baseUrl:t,url:n}=e,i=e.future.experimental_router,s=(0,r.useCallback)(((e,r)=>function(e){let{siteUrl:t,baseUrl:n,url:r,options:{forcePrependBaseUrl:o=!1,absolute:i=!1}={},router:s}=e;if(!r||r.startsWith("#")||(0,a.z)(r))return r;if("hash"===s)return r.startsWith("/")?`.${r}`:`./${r}`;if(o)return n+r.replace(/^\//,"");if(r===n.replace(/\/$/,""))return n;const l=r.startsWith(n)?r:n+r.replace(/^\//,"");return i?t+l:l}({siteUrl:n,baseUrl:t,url:e,options:r,router:i})),[n,t,i]);return{withBaseUrl:s}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},3427:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var r=n(6540);n(4848);const o=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),a=()=>(0,r.useContext)(o);function i(){return a()}},4586:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6988);function a(){return(0,r.useContext)(o.o)}},2303:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6125);function a(){return(0,r.useContext)(o.o)}},205:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(6540);const o=n(8193).A.canUseDOM?r.useLayoutEffect:r.useEffect},6803:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(3102);function a(){const e=r.useContext(o.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}},6921:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const s=o?`${o}.${a}`:a;r(i)?e(i,s):t[s]=i}))}(e),t}},3102:(e,t,n)=>{"use strict";n.d(t,{W:()=>i,o:()=>a});var r=n(6540),o=n(4848);const a=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(a),s=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,o.jsx)(a.Provider,{value:s,children:t})}},3886:(e,t,n)=>{"use strict";n.d(t,{VQ:()=>g,XK:()=>v,g1:()=>y});var r=n(6540),o=n(4070),a=n(7065),i=n(6342),s=n(679),l=n(9532),c=n(4848);const u=e=>`docs-preferred-version-${e}`,d={save:(e,t,n)=>{(0,s.Wf)(u(e),{persistence:t}).set(n)},read:(e,t)=>(0,s.Wf)(u(e),{persistence:t}).get(),clear:(e,t)=>{(0,s.Wf)(u(e),{persistence:t}).del()}},p=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const f=r.createContext(null);function m(){const e=(0,o.Gy)(),t=(0,i.p)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[a,s]=(0,r.useState)((()=>p(n)));(0,r.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function o(e){const t=d.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(d.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,o(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[a,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d.save(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=m();return(0,c.jsx)(f.Provider,{value:n,children:t})}function g(e){let{children:t}=e;return(0,c.jsx)(h,{children:t})}function b(){const e=(0,r.useContext)(f);if(!e)throw new l.dV("DocsPreferredVersionContextProvider");return e}function y(e){void 0===e&&(e=a.W);const t=(0,o.ht)(e),[n,i]=b(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}function v(){const e=(0,o.Gy)(),[t]=b();function n(n){const r=e[n],{preferredVersionName:o}=t[n];return r.versions.find((e=>e.name===o))??null}const r=Object.keys(e);return Object.fromEntries(r.map((e=>[e,n(e)])))}},2565:(e,t,n)=>{"use strict";n.d(t,{k:()=>a,v:()=>i});var r=n(4070),o=n(3886);function a(e,t){return`docs-${e}-${t}`}function i(){const e=(0,r.Gy)(),t=(0,r.gk)(),n=(0,o.XK)();return[...Object.keys(e).map((function(r){const o=t?.activePlugin.pluginId===r?t.activeVersion:void 0,i=n[r],s=e[r].versions.find((e=>e.isLast));return a(r,(o??i??s).name)}))]}},609:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,t:()=>c});var r=n(6540),o=n(9532),a=n(4848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(s.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},6972:(e,t,n)=>{"use strict";n.d(t,{$S:()=>m,B5:()=>E,Nr:()=>f,OF:()=>S,QB:()=>_,Vd:()=>k,Y:()=>v,cC:()=>p,d1:()=>C,fW:()=>x,w8:()=>b});var r=n(6540),o=n(6347),a=n(2831),i=n(4070),s=n(9169),l=n(1682),c=n(3886),u=n(3025),d=n(609);function p(e){const t=(0,u.r)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}function m(){const{pathname:e}=(0,o.zy)(),t=(0,d.t)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=w({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const h=(e,t)=>void 0!==e&&(0,s.ys)(e,t),g=(e,t)=>e.some((e=>b(e,t)));function b(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||g(e.items,t))}function y(e,t){switch(e.type){case"category":return b(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||b(e,t);default:return!0}}function v(e,t){return(0,r.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function w(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const o=[];return function e(t){for(const a of t)if("category"===a.type&&((0,s.ys)(a.href,n)||e(a.items))||"link"===a.type&&(0,s.ys)(a.href,n)){return r&&"category"!==a.type||o.unshift(a),!0}return!1}(t),o}function S(){const e=(0,d.t)(),{pathname:t}=(0,o.zy)(),n=(0,i.vT)()?.pluginData.breadcrumbs;return!1!==n&&e?w({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.zK)(e),{preferredVersion:n}=(0,c.g1)(e),o=(0,i.r7)(e);return(0,r.useMemo)((()=>(0,l.sb)([t,n,o].filter(Boolean))),[t,n,o])}function x(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function _(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,l.sb)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,o.zy)(),r=(0,u.r)(),i=t.routes,s=i.find((e=>(0,o.B6)(n.pathname,e)));if(!s)return null;const l=s.sidebar,c=l?r.docsSidebars[l]:void 0;return{docElement:(0,a.v)(i),sidebarName:l,sidebarItems:c}}function C(e){return e.filter((e=>!("category"===e.type||"link"===e.type)||!!f(e)))}},3025:(e,t,n)=>{"use strict";n.d(t,{n:()=>s,r:()=>l});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},4070:(e,t,n)=>{"use strict";n.d(t,{zK:()=>b,vT:()=>f,gk:()=>m,Gy:()=>d,HW:()=>y,ht:()=>p,r7:()=>g,jh:()=>h});var r=n(6347),o=n(4586),a=n(7065);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,o.A)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find((e=>e.isLast));function l(e,t){return[...e.versions].sort(((e,t)=>e.path===t.path?0:e.path.includes(t.path)?-1:t.path.includes(e.path)?1:0)).find((e=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1})))}function c(e,t){const n=l(e,t),o=n?.docs.find((e=>!!(0,r.B6)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:o,alternateDocVersions:o?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(o.id):{}}}const u={},d=()=>i("docusaurus-plugin-content-docs")??u,p=e=>{try{return function(e,t,n){void 0===t&&(t=a.W),void 0===n&&(n={});const r=i(e),o=r?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function f(e){void 0===e&&(e={});const t=d(),{pathname:n}=(0,r.zy)();return function(e,t,n){void 0===n&&(n={});const o=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.B6)(t,{path:n.path,exact:!1,strict:!1})})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return a}(t,n,e)}function m(e){void 0===e&&(e={});const t=f(e),{pathname:n}=(0,r.zy)();if(!t)return;return{activePlugin:t,activeVersion:l(t.pluginData,n)}}function h(e){return p(e).versions}function g(e){const t=p(e);return s(t)}function b(e){const t=p(e),{pathname:n}=(0,r.zy)();return c(t,n)}function y(e){const t=p(e),{pathname:n}=(0,r.zy)();return function(e,t){const n=s(e);return{latestDocSuggestion:c(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},6294:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(5947),o=n.n(r);o().configure({showSpinner:!1});const a={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{o().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},6134:(e,t,n)=>{"use strict";n.r(t);var r=n(1765),o=n(4784);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(9700),n(4523)(`./prism-${e}`)})),delete globalThis.Prism}(r.My)},1107:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(4164),o=n(1312),a=n(6342),i=n(8774),s=n(3427);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(4848);function u(e){let{as:t,id:n,...u}=e;const d=(0,s.A)(),{navbar:{hideOnScroll:p}}=(0,a.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,o.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.A)("anchor",p?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.A,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},3186:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(4848);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},3277:(e,t,n)=>{"use strict";n.d(t,{A:()=>Ct});var r=n(6540),o=n(4164),a=n(7489),i=n(5500),s=n(6347),l=n(1312),c=n(5062),u=n(4848);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,s.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,l.T)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){const t=e.children??m,{containerRef:n,onClick:r}=f();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var g=n(7559),b=n(4090);const y={skipToContent:"skipToContent_fXgn"};function v(){return(0,u.jsx)(h,{className:y.skipToContent})}var w=n(6342),S=n(5041);function k(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:o=1.2,className:a,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:o,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const x={closeButton:"closeButton_CVFx"};function _(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.A)("clean-btn close",x.closeButton,e.className),children:(0,u.jsx)(k,{width:14,height:14,strokeWidth:3.1})})}const E={content:"content_knG7"};function C(e){const{announcementBar:t}=(0,w.p)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,o.A)(E.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const O={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function P(){const{announcementBar:e}=(0,w.p)(),{isActive:t,close:n}=(0,S.M)();if(!t)return null;const{backgroundColor:r,textColor:o,isCloseable:a}=e;return(0,u.jsxs)("div",{className:O.announcementBar,style:{backgroundColor:r,color:o},role:"banner",children:[a&&(0,u.jsx)("div",{className:O.announcementBarPlaceholder}),(0,u.jsx)(C,{className:O.announcementBarContent}),a&&(0,u.jsx)(_,{onClick:n,className:O.announcementBarClose})]})}var T=n(2069),A=n(3104);var j=n(9532),R=n(5600);const I=r.createContext(null);function D(e){let{children:t}=e;const n=function(){const e=(0,T.M)(),t=(0,R.YL)(),[n,o]=(0,r.useState)(!1),a=null!==t.component,i=(0,j.ZC)(a);return(0,r.useEffect)((()=>{a&&!i&&o(!0)}),[a,i]),(0,r.useEffect)((()=>{a?e.shown||o(!0):o(!1)}),[e.shown,a]),(0,r.useMemo)((()=>[n,o]),[n])}();return(0,u.jsx)(I.Provider,{value:n,children:t})}function L(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function N(){const e=(0,r.useContext)(I);if(!e)throw new j.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,o=(0,r.useCallback)((()=>n(!1)),[n]),a=(0,R.YL)();return(0,r.useMemo)((()=>({shown:t,hide:o,content:L(a)})),[o,a,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:a}=N();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,o.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":a}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var F=n(5293),B=n(2303);function z(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function U(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const $={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:a}=e;const i=(0,B.A)(),s=(0,l.T)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,l.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,o.A)($.toggle,t),children:(0,u.jsxs)("button",{className:(0,o.A)("clean-btn",$.toggleButton,!i&&$.toggleButtonDisabled,n),type:"button",onClick:()=>a("dark"===r?"light":"dark"),disabled:!i,title:s,"aria-label":s,"aria-live":"polite",children:[(0,u.jsx)(z,{className:(0,o.A)($.toggleIcon,$.lightToggleIcon)}),(0,u.jsx)(U,{className:(0,o.A)($.toggleIcon,$.darkToggleIcon)})]})})}const H=r.memo(q),G={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function V(e){let{className:t}=e;const n=(0,w.p)().navbar.style,r=(0,w.p)().colorMode.disableSwitch,{colorMode:o,setColorMode:a}=(0,F.G)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?G.darkNavbarColorModeToggle:void 0,value:o,onChange:a})}var W=n(3465);function K(){return(0,u.jsx)(W.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,T.M)();return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(k,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(K,{}),(0,u.jsx)(V,{className:"margin-right--md"}),(0,u.jsx)(Q,{})]})}var Z=n(8774),J=n(6025),X=n(6654),ee=n(1252),te=n(3186);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:o,label:a,html:i,isDropdownLink:s,prependBaseUrlToHref:l,...c}=e;const d=(0,J.Ay)(r),p=(0,J.Ay)(t),f=(0,J.Ay)(o,{forcePrependBaseUrl:!0}),m=a&&o&&!(0,X.A)(o),h=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[a,m&&(0,u.jsx)(te.A,{...s&&{width:12,height:12}})]})};return o?(0,u.jsx)(Z.A,{href:l?f:o,...c,...h}):(0,u.jsx)(Z.A,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?(0,ee.G)(n,t.pathname):t.pathname.startsWith(p)},...c,...h})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const a=(0,u.jsx)(ne,{className:(0,o.A)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:a}):a}function oe(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,o.A)("menu__link",t),...r})})}function ae(e){let{mobile:t=!1,position:n,...r}=e;const o=t?oe:re;return(0,u.jsx)(o,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(1422),se=n(9169),le=n(4586);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,se.ys)(e.to,t)||!!(0,ee.G)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:a,onClick:i,...s}=e;const l=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[l]),(0,u.jsxs)("div",{ref:l,className:(0,o.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:s.to?void 0:"#",className:(0,o.A)("navbar__link",a),...s,onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:s.children??s.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Fe,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:a,onClick:i,...l}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,le.A)(),{pathname:t}=(0,s.zy)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[c,d,m]),(0,u.jsxs)("li",{className:(0,o.A)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,o.A)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...l,onClick:e=>{e.preventDefault(),f()},children:l.children??l.label}),(0,u.jsx)(ie.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Fe,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,u.jsx)(r,{...n})}var me=n(2131);function he(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_nlXk";var be=n(961),ye=n(3219),ve=n(5260),we=n(4255),Se=n(1062),ke=n(2967),xe=n(2565);function _e(){return[`language:${(0,le.A)().i18n.currentLocale}`,function(){const e=(0,xe.v)();return[ke.C,...e]}().map((e=>`docusaurus_tag:${e}`))]}const Ee={button:{buttonText:(0,l.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,l.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,l.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,l.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,l.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,l.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,l.T)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,l.T)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,l.T)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,l.T)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,l.T)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,l.T)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,l.T)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,l.T)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,l.T)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,l.T)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let Ce=null;function Oe(e){let{hit:t,children:n}=e;return(0,u.jsx)(Z.A,{to:t.url,children:n})}function Pe(e){let{state:t,onClose:n}=e;const r=(0,we.w)();return(0,u.jsx)(Z.A,{to:r(t.query),onClick:n,children:(0,u.jsx)(l.A,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits},children:"See all {count} results"})})}function Te(e){let{contextualSearch:t,externalUrlRegex:o,...a}=e;const{siteMetadata:i}=(0,le.A)(),l=(0,Se.C)(),c=_e(),d=a.searchParameters?.facetFilters??[],p=t?function(e,t){const n=e=>"string"==typeof e?[e]:e;return[...n(e),...n(t)]}(c,d):d,f={...a.searchParameters,facetFilters:p},m=(0,s.W6)(),h=(0,r.useRef)(null),g=(0,r.useRef)(null),[b,y]=(0,r.useState)(!1),[v,w]=(0,r.useState)(void 0),S=(0,r.useCallback)((()=>Ce?Promise.resolve():Promise.all([n.e(8158).then(n.bind(n,8158)),Promise.all([n.e(1869),n.e(8913)]).then(n.bind(n,8913)),Promise.all([n.e(1869),n.e(416)]).then(n.bind(n,416))]).then((e=>{let[{DocSearchModal:t}]=e;Ce=t}))),[]),k=(0,r.useCallback)((()=>{if(!h.current){const e=document.createElement("div");h.current=e,document.body.insertBefore(e,document.body.firstChild)}}),[]),x=(0,r.useCallback)((()=>{k(),S().then((()=>y(!0)))}),[S,k]),_=(0,r.useCallback)((()=>{y(!1),g.current?.focus()}),[]),E=(0,r.useCallback)((e=>{"f"===e.key&&(e.metaKey||e.ctrlKey)||(e.preventDefault(),w(e.key),x())}),[x]),C=(0,r.useRef)({navigate(e){let{itemUrl:t}=e;(0,ee.G)(o,t)?window.location.href=t:m.push(t)}}).current,O=(0,r.useRef)((e=>a.transformItems?a.transformItems(e):e.map((e=>({...e,url:l(e.url)}))))).current,P=(0,r.useMemo)((()=>e=>(0,u.jsx)(Pe,{...e,onClose:_})),[_]),T=(0,r.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",i.docusaurusVersion),e)),[i.docusaurusVersion]);return(0,ye.E8)({isOpen:b,onOpen:x,onClose:_,onInput:E,searchButtonRef:g}),(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(ve.A,{children:(0,u.jsx)("link",{rel:"preconnect",href:`https://${a.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})}),(0,u.jsx)(ye.Bc,{onTouchStart:S,onFocus:S,onMouseOver:S,onClick:x,ref:g,translations:Ee.button}),b&&Ce&&h.current&&(0,be.createPortal)((0,u.jsx)(Ce,{onClose:_,initialScrollY:window.scrollY,initialQuery:v,navigator:C,transformItems:O,hitComponent:Oe,transformSearchClient:T,...a.searchPagePath&&{resultsFooterComponent:P},...a,searchParameters:f,placeholder:Ee.placeholder,translations:Ee.modal}),h.current)]})}function Ae(){const{siteConfig:e}=(0,le.A)();return(0,u.jsx)(Te,{...e.themeConfig.algolia})}const je={navbarSearchContainer:"navbarSearchContainer_Bca1"};function Re(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,o.A)(n,je.navbarSearchContainer),children:t})}var Ie=n(4070),De=n(6972);var Le=n(3886);function Ne(e,t){return t.alternateDocVersions[e.name]??function(e){return e.docs.find((t=>t.id===e.mainDocId))}(e)}const Me={default:ae,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:o="",...a}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,le.A)(),p=(0,me.o)(),{search:f,hash:m}=(0,s.zy)(),h=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${o}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,l.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(fe,{...a,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(he,{className:ge}),g]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(Re,{className:n,children:(0,u.jsx)(Ae,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:a=!1}=e;const i=a?"li":"div";return(0,u.jsx)(i,{className:(0,o.A)({navbar__item:!r&&!a,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ie.zK)(r),i=(0,De.QB)(t,r),s=a?.path===i?.path;return null===i||i.unlisted&&!s?null:(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>s||!!a?.sidebar&&a.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ie.zK)(r),i=(0,De.fW)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>a?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...o}=e;const a=(0,De.Vd)(r)[0],i=t??a.label,s=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(a).path;return(0,u.jsx)(ae,{...o,label:i,to:s})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:o,dropdownItemsAfter:a,...i}=e;const{search:c,hash:d}=(0,s.zy)(),p=(0,Ie.zK)(n),f=(0,Ie.jh)(n),{savePreferredVersionName:m}=(0,Le.g1)(n),h=[...o,...f.map((function(e){const t=Ne(e,p);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...a],g=(0,De.Vd)(n)[0],b=t&&h.length>1?(0,l.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,y=t&&h.length>1?void 0:Ne(g,p).path;return h.length<=1?(0,u.jsx)(ae,{...i,mobile:t,label:b,to:y,isActive:r?()=>!1:void 0}):(0,u.jsx)(fe,{...i,mobile:t,label:b,to:y,items:h,isActive:r?()=>!1:void 0})},"custom-glnb":()=>(0,u.jsx)("a",{className:"navbar-lic-button",onClick:()=>{window.posthog&&window.posthog.capture("click_checkout")},href:"https://gum.co/BTMt?tier=1%20Restricted%20License",children:"Get License"})};function Fe(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Me[r];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(o,{...n})}function Be(){const e=(0,T.M)(),t=(0,w.p)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Fe,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function ze(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(l.A,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Ue(){const e=0===(0,w.p)().navbar.items.length,t=N();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(ze,{onClick:()=>t.hide()}),t.content]})}function $e(){const e=(0,T.M)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(M,{header:(0,u.jsx)(Y,{}),primaryMenu:(0,u.jsx)(Be,{}),secondaryMenu:(0,u.jsx)(Ue,{})}):null}const qe={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function He(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,o.A)("navbar-sidebar__backdrop",e.className)})}function Ge(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:a}}=(0,w.p)(),i=(0,T.M)(),{navbarRef:s,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),o=(0,r.useRef)(!1),a=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(a.current=e.getBoundingClientRect().height)}),[]);return(0,A.Mq)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=s?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return o.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:s,"aria-label":(0,l.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.A)("navbar","navbar--fixed-top",n&&[qe.navbarHideable,!d&&qe.navbarHidden],{"navbar--dark":"dark"===a,"navbar--primary":"primary"===a,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(He,{onClick:i.toggle}),(0,u.jsx)($e,{})]})}var Ve=n(440);const We={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function Ke(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Qe(e){let{error:t}=e;const n=(0,Ve.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:We.errorBoundaryError,children:n})}class Ye extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Ze="right";function Je(e){let{width:t=30,height:n=30,className:r,...o}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...o,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Xe(){const{toggle:e,shown:t}=(0,T.M)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,l.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(Je,{})})}const et={colorModeToggle:"colorModeToggle_DEke"};function tt(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(Ye,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(Fe,{...e})},t)))})}function nt(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function rt(){const e=(0,T.M)(),t=(0,w.p)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??Ze)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return(0,u.jsx)(nt,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Xe,{}),(0,u.jsx)(K,{}),(0,u.jsx)(tt,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(tt,{items:r}),(0,u.jsx)(V,{className:et.colorModeToggle}),!o&&(0,u.jsx)(Re,{children:(0,u.jsx)(Ae,{})})]})})}function ot(){return(0,u.jsx)(Ge,{children:(0,u.jsx)(rt,{})})}function at(e){let{item:t}=e;const{to:n,href:r,label:o,prependBaseUrlToHref:a,...i}=t,s=(0,J.Ay)(n),l=(0,J.Ay)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(Z.A,{className:"footer__link-item",...r?{href:a?l:r}:{to:s},...i,children:[o,r&&!(0,X.A)(r)&&(0,u.jsx)(te.A,{})]})}function it(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(at,{item:t})},t.href??t.to)}function st(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(it,{item:e},t)))})]})}function lt(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(st,{column:e},t)))})}function ct(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function ut(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(at,{item:t})}function dt(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(ut,{item:e}),t.length!==n+1&&(0,u.jsx)(ct,{})]},n)))})})}function pt(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(lt,{columns:t}):(0,u.jsx)(dt,{links:t})}var ft=n(1122);const mt={footerLogoLink:"footerLogoLink_BH7S"};function ht(e){let{logo:t}=e;const{withBaseUrl:n}=(0,J.hH)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(ft.A,{className:(0,o.A)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function gt(e){let{logo:t}=e;return t.href?(0,u.jsx)(Z.A,{href:t.href,className:mt.footerLogoLink,target:t.target,children:(0,u.jsx)(ht,{logo:t})}):(0,u.jsx)(ht,{logo:t})}function bt(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function yt(e){let{style:t,links:n,logo:r,copyright:a}=e;return(0,u.jsx)("footer",{className:(0,o.A)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||a)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),a]})]})})}function vt(){const{footer:e}=(0,w.p)();if(!e)return null;const{copyright:t,links:n,logo:r,style:o}=e;return(0,u.jsx)(yt,{style:o,links:n&&n.length>0&&(0,u.jsx)(pt,{links:n}),logo:r&&(0,u.jsx)(gt,{logo:r}),copyright:t&&(0,u.jsx)(bt,{copyright:t})})}const wt=r.memo(vt),St=(0,j.fM)([F.a,S.o,A.Tv,Le.VQ,i.Jx,function(e){let{children:t}=e;return(0,u.jsx)(R.y_,{children:(0,u.jsx)(T.e,{children:(0,u.jsx)(D,{children:t})})})}]);function kt(e){let{children:t}=e;return(0,u.jsx)(St,{children:t})}var xt=n(1107);function _t(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(xt.A,{as:"h1",className:"hero__title",children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)(Ke,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Qe,{error:t})})]})})})}const Et={mainWrapper:"mainWrapper_z2l0"};function Ct(e){const{children:t,noFooter:n,wrapperClassName:r,title:s,description:l}=e;return(0,b.J)(),(0,u.jsxs)(kt,{children:[(0,u.jsx)(i.be,{title:s,description:l}),(0,u.jsx)(v,{}),(0,u.jsx)(P,{}),(0,u.jsx)(ot,{}),(0,u.jsx)("div",{id:d,className:(0,o.A)(g.G.wrapper.main,Et.mainWrapper,r),children:(0,u.jsx)(a.A,{fallback:e=>(0,u.jsx)(_t,{...e}),children:t})}),!n&&(0,u.jsx)(wt,{})]})}},3465:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(8774),o=n(6025),a=n(4586),i=n(6342),s=n(1122),l=n(4848);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.Ay)(t.src),dark:(0,o.Ay)(t.srcDark||t.src)},i=(0,l.jsx)(s.A,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,l.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.A)(),{navbar:{title:n,logo:s}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.Ay)(s?.href||"/"),m=n?"":t,h=s?.alt??m;return(0,l.jsxs)(r.A,{to:f,...p,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:h,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},1463:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(5260),o=n(4848);function a(e){let{locale:t,version:n,tag:a}=e;const i=t;return(0,o.jsxs)(r.A,{children:[t&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,o.jsx)("meta",{name:"docusaurus_version",content:n}),a&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:a}),i&&(0,o.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,o.jsx)("meta",{name:"docsearch:version",content:n}),a&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:a})]})}},1122:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});var r=n(6540),o=n(4164),a=n(2303),i=n(5293);const s={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var l=n(4848);function c(e){let{className:t,children:n}=e;const c=(0,a.A)(),{colorMode:u}=(0,i.G)();return(0,l.jsx)(l.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const a=n({theme:e,className:(0,o.A)(t,s.themedComponent,s[`themedComponent--${e}`])});return(0,l.jsx)(r.Fragment,{children:a},e)}))})}function u(e){const{sources:t,className:n,alt:r,...o}=e;return(0,l.jsx)(c,{className:n,children:e=>{let{theme:n,className:a}=e;return(0,l.jsx)("img",{src:t[n],alt:r,className:a,...o})}})}},1422:(e,t,n)=>{"use strict";n.d(t,{N:()=>b,u:()=>c});var r=n(6540),o=n(8193),a=n(205),i=n(3109),s=n(4848);const l="ease-in-out";function c(e){let{initialState:t}=e;const[n,o]=(0,r.useState)(t??!1),a=(0,r.useCallback)((()=>{o((e=>!e))}),[]);return{collapsed:n,setCollapsed:o,toggleCollapsed:a}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:o}=e;const a=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=o?.duration??function(e){if((0,i.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${o?.easing??l}`,height:`${t}px`}}function s(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!a.current)return p(e,n),void(a.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,o])}function m(e){if(!o.A.canUseDOM)return e?u:d}function h(e){let{as:t="div",collapsed:n,children:o,animation:a,onCollapseTransitionEnd:i,className:l,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:a}),(0,s.jsx)(t,{ref:u,style:c?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:l,children:o})}function g(e){let{collapsed:t,...n}=e;const[o,i]=(0,r.useState)(!t),[l,c]=(0,r.useState)(t);return(0,a.A)((()=>{t||i(!0)}),[t]),(0,a.A)((()=>{o&&c(t)}),[o,t]),o?(0,s.jsx)(h,{...n,collapsed:l}):null}function b(e){let{lazy:t,...n}=e;const r=t?g:h;return(0,s.jsx)(r,{...n})}},5041:(e,t,n)=>{"use strict";n.d(t,{M:()=>h,o:()=>m});var r=n(6540),o=n(2303),a=n(679),i=n(9532),s=n(6342),l=n(4848);const c=(0,a.Wf)("docusaurus.announcement.dismiss"),u=(0,a.Wf)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.p)(),t=(0,o.A)(),[n,a]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{a(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),a(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||a(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,l.jsx)(f.Provider,{value:n,children:t})}function h(){const e=(0,r.useContext)(f);if(!e)throw new i.dV("AnnouncementBarProvider");return e}},5293:(e,t,n)=>{"use strict";n.d(t,{G:()=>b,a:()=>g});var r=n(6540),o=n(8193),a=n(9532),i=n(679),s=n(6342),l=n(4848);const c=r.createContext(void 0),u="theme",d=(0,i.Wf)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>o.A.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),[o,a]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&h(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const l=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||l.current?l.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[o,i])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function b(){const e=(0,r.useContext)(c);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},2069:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(6540),o=n(5600),a=n(4581),i=n(7485),s=n(6342),l=n(9532),c=n(4848);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,s.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[l,c]=(0,r.useState)(!1);(0,i.$Z)((()=>{if(l)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:l})),[e,n,u,l])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new l.dV("NavbarMobileSidebarProvider");return e}},5600:(e,t,n)=>{"use strict";n.d(t,{GX:()=>c,YL:()=>l,y_:()=>s});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(!e)throw new o.dV("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const a=(0,r.useContext)(i);if(!a)throw new o.dV("NavbarSecondaryMenuContentProvider");const[,s]=a,l=(0,o.Be)(n);return(0,r.useEffect)((()=>{s({component:t,props:l})}),[s,t,l]),(0,r.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},4090:(e,t,n)=>{"use strict";n.d(t,{w:()=>o,J:()=>a});var r=n(6540);const o="navigation-with-keyboard";function a(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},4255:(e,t,n)=>{"use strict";n.d(t,{b:()=>s,w:()=>l});var r=n(6540),o=n(4586),a=n(7485);const i="q";function s(){return(0,a.l)(i)}function l(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,o.A)(),{algolia:{searchPagePath:n}}=t;return(0,r.useCallback)((t=>`${e}${n}?${i}=${encodeURIComponent(t)}`),[e,n])}},4581:(e,t,n)=>{"use strict";n.d(t,{l:()=>s});var r=n(6540),o=n(8193);const a={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function s(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,s]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){s(function(e){if(!o.A.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?a.desktop:a.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},7559:(e,t,n)=>{"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",blogAuthorsListPage:"blog-authors-list-page",blogAuthorsPostsPage:"blog-authors-posts-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",draftBanner:"theme-draft-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},3109:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>r})},481:(e,t,n)=>{"use strict";n.d(t,{s:()=>o});var r=n(4586);function o(e){const{siteConfig:t}=(0,r.A)(),{title:n,titleDelimiter:o}=t;return e?.trim().length?`${e.trim()} ${o} ${n}`:n}},7485:(e,t,n)=>{"use strict";n.d(t,{$Z:()=>i,aZ:()=>l,l:()=>c});var r=n(6540),o=n(6347),a=n(9532);function i(e){!function(e){const t=(0,o.W6)(),n=(0,a._q)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function s(e){const t=(0,o.W6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function l(e){return s((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function c(e){const t=l(e)??"",n=function(e){const t=(0,o.W6)();return(0,r.useCallback)(((n,r)=>{const o=new URLSearchParams(t.location.search);n?o.set(e,n):o.delete(e),(r?.push?t.push:t.replace)({search:o.toString()})}),[e,t])}(e);return[t,n]}},1682:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function o(e){return Array.from(new Set(e))}function a(e,t){const n={};let r=0;for(const o of e){const e=t(o,r);n[e]??=[],n[e].push(o),r+=1}return n}n.d(t,{$z:()=>a,XI:()=>r,sb:()=>o})},5500:(e,t,n)=>{"use strict";n.d(t,{Jx:()=>f,be:()=>u,e3:()=>p});var r=n(6540),o=n(4164),a=n(5260),i=n(6803),s=n(6025),l=n(481),c=n(4848);function u(e){let{title:t,description:n,keywords:r,image:o,children:i}=e;const u=(0,l.s)(t),{withBaseUrl:d}=(0,s.hH)(),p=o?d(o,{absolute:!0}):void 0;return(0,c.jsxs)(a.A,{children:[t&&(0,c.jsx)("title",{children:u}),t&&(0,c.jsx)("meta",{property:"og:title",content:u}),n&&(0,c.jsx)("meta",{name:"description",content:n}),n&&(0,c.jsx)("meta",{property:"og:description",content:n}),r&&(0,c.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,c.jsx)("meta",{property:"og:image",content:p}),p&&(0,c.jsx)("meta",{name:"twitter:image",content:p}),i]})}const d=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const i=r.useContext(d),s=(0,o.A)(i,t);return(0,c.jsxs)(d.Provider,{value:s,children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("html",{className:s})}),n]})}function f(e){let{children:t}=e;const n=(0,i.A)(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const a=`plugin-id-${n.plugin.id}`;return(0,c.jsx)(p,{className:(0,o.A)(r,a),children:t})}},9532:(e,t,n)=>{"use strict";n.d(t,{Be:()=>c,ZC:()=>s,_q:()=>i,dV:()=>l,fM:()=>u});var r=n(6540),o=n(205),a=n(4848);function i(e){const t=(0,r.useRef)(e);return(0,o.A)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function s(e){const t=(0,r.useRef)();return(0,o.A)((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,a.jsx)(a.Fragment,{children:e.reduceRight(((e,t)=>(0,a.jsx)(t,{children:e})),n)})}}},1252:(e,t,n)=>{"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{G:()=>r})},9169:(e,t,n)=>{"use strict";n.d(t,{Dt:()=>s,ys:()=>i});var r=n(6540),o=n(8328),a=n(4586);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,a.A)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function o(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(o).flatMap((e=>e.routes??[])))}(n)}({routes:o.A,baseUrl:e})),[e])}},3104:(e,t,n)=>{"use strict";n.d(t,{Mq:()=>f,Tv:()=>u,a_:()=>m,gk:()=>h});var r=n(6540),o=n(8193),a=n(2303),i=n(205),s=n(9532),l=n(4848);const c=r.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new s.dV("ScrollControllerProvider");return e}const p=()=>o.A.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),o=(0,r.useRef)(p()),a=(0,s._q)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();a(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[a,n,...t])}function m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),o=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.A)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:o}}function h(){const e=(0,r.useRef)(null),t=(0,a.A)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const o=document.documentElement.scrollTop;(n&&o>e||!n&&ot&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},2967:(e,t,n)=>{"use strict";n.d(t,{C:()=>r});const r="default"},679:(e,t,n)=>{"use strict";n.d(t,{Wf:()=>u,Dv:()=>d});var r=n(6540);const o=JSON.parse('{"N":"localStorage","M":""}'),a=o.N;function i(e){let{key:t,oldValue:n,newValue:r,storage:o}=e;if(n===r)return;const a=document.createEvent("StorageEvent");a.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,o),window.dispatchEvent(a)}function s(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const c={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){const n=`${e}${o.M}`;if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(n);const r=s(t?.persistence);return null===r?c:{get:()=>{try{return r.getItem(n)}catch(e){return console.error(`Docusaurus storage error, can't get key=${n}`,e),null}},set:e=>{try{const t=r.getItem(n);r.setItem(n,e),i({key:n,oldValue:t,newValue:e,storage:r})}catch(t){console.error(`Docusaurus storage error, can't set ${n}=${e}`,t)}},del:()=>{try{const e=r.getItem(n);r.removeItem(n),i({key:n,oldValue:e,newValue:null,storage:r})}catch(e){console.error(`Docusaurus storage error, can't delete key=${n}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===r&&t.key===n&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${n}`,t),()=>{}}}}}function d(e,t){const n=(0,r.useRef)((()=>null===e?c:u(e,t))).current(),o=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(o,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},2131:(e,t,n)=>{"use strict";n.d(t,{o:()=>i});var r=n(4586),o=n(6347),a=n(440);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:s}}=(0,r.A)(),{pathname:l}=(0,o.zy)(),c=(0,a.Ks)(l,{trailingSlash:n,baseUrl:e}),u=s===i?e:e.replace(`/${s}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5062:(e,t,n)=>{"use strict";n.d(t,{$:()=>i});var r=n(6540),o=n(6347),a=n(9532);function i(e){const t=(0,o.zy)(),n=(0,a.ZC)(t),i=(0,a._q)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6342:(e,t,n)=>{"use strict";n.d(t,{p:()=>o});var r=n(4586);function o(){return(0,r.A)().siteConfig.themeConfig}},8126:(e,t,n)=>{"use strict";n.d(t,{c:()=>o});var r=n(4586);function o(){const{siteConfig:{themeConfig:e}}=(0,r.A)();return e}},1062:(e,t,n)=>{"use strict";n.d(t,{C:()=>s});var r=n(6540),o=n(1252),a=n(6025),i=n(8126);function s(){const{withBaseUrl:e}=(0,a.hH)(),{algolia:{externalUrlRegex:t,replaceSearchResultPathname:n}}=(0,i.c)();return(0,r.useCallback)((r=>{const a=new URL(r);if((0,o.G)(t,a.href))return r;const i=`${a.pathname+a.hash}`;return e(function(e,t){return t?e.replaceAll(new RegExp(t.from,"g"),t.to):e}(i,n))}),[e,t,n])}},2983:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addTrailingSlash=o,t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[i]=e.split(/[#?]/),s="/"===i||i===r?i:(l=i,c=n,c?o(l):a(l));var l,c;return e.replace(i,s)},t.addLeadingSlash=function(e){return(0,r.addPrefix)(e,"/")},t.removeTrailingSlash=a;const r=n(2566);function o(e){return e.endsWith("/")?e:`${e}/`}function a(e){return(0,r.removeSuffix)(e,"/")}},253:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=function e(t){if(t.cause)return[t,...e(t.cause)];return[t]}},440:(e,t,n)=>{"use strict";t.rA=t.Ks=t.LU=void 0;const r=n(1635);t.LU="__blog-post-container";var o=n(2983);Object.defineProperty(t,"Ks",{enumerable:!0,get:function(){return r.__importDefault(o).default}});var a=n(2566);var i=n(253);Object.defineProperty(t,"rA",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},2566:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){if(""===t)return e;return e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},9530:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>r});const r=n(8193).A.canUseDOM?{onRouteUpdate(){window.posthog.capture("$pageview")}}:null},1513:(e,t,n)=>{"use strict";n.d(t,{zR:()=>w,TM:()=>C,yJ:()=>f,sC:()=>P,AO:()=>p});var r=n(8168);function o(e){return"/"===e.charAt(0)}function a(e,t){for(var n=t,r=n+1,o=e.length;r=0;p--){var f=i[p];"."===f?a(i,p):".."===f?(a(i,p),d++):d&&(a(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&o(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var s=n(1561);function l(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function f(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.A)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",o=f(e,t,h(),w.location);u.confirmTransitionTo(o,r,n,(function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(4363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return r.isMemo(e)?i:s[e.$$typeof]||o}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var o=f(n);o&&o!==m&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=l(t),h=l(n),g=0;g{"use strict";e.exports=function(e,t,n,r,o,a,i,s){if(!e){var l;if(void 0===t)l=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,s],u=0;(l=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw l.framesToPop=1,l}}},4634:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},119:(e,t,n)=>{"use strict";n.r(t)},1043:(e,t,n)=>{"use strict";n.r(t)},5947:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(c,i(e,u,d)),1===e?(l(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){l(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},5302:(e,t,n)=>{var r=n(4634);e.exports=f,e.exports.parse=a,e.exports.compile=function(e,t){return s(a(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=p;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function a(e,t){for(var n,r=[],a=0,i=0,s="",u=t&&t.delimiter||"/";null!=(n=o.exec(e));){var d=n[0],p=n[1],f=n.index;if(s+=e.slice(i,f),i=f+d.length,p)s+=p[1];else{var m=e[i],h=n[2],g=n[3],b=n[4],y=n[5],v=n[6],w=n[7];s&&(r.push(s),s="");var S=null!=h&&null!=m&&m!==h,k="+"===v||"*"===v,x="?"===v||"*"===v,_=n[2]||u,E=b||y;r.push({name:g||a++,prefix:h||"",delimiter:_,optional:x,repeat:k,partial:S,asterisk:!!w,pattern:E?c(E):w?".*":"[^"+l(_)+"]+?"})}}return i{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;l=a.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++o;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(m+f.length),y=[];h&&y.push.apply(y,i([h])),y.push(g),b&&y.push.apply(y,i([b])),"string"==typeof c?s.splice.apply(s,[l,1].concat(y)):c.content=y}}else c.content&&i(c.content)}return s}(n.tokens)}}}})}(Prism)},4523:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=4523},3157:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=3157},8380:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var s={},l=e[r];if(l){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in s))for(var i in o(t,a),s[t]=!0,n[t])s[i]=!0}t(l.require,c),t(l.optional,c),t(l.modify,c)}n[r]=s,a.pop()}}return function(e){var t=n[e];return t||(o(e,r),t=n[e]),t}}function o(e){for(var t in e)return!0;return!1}return function(a,i,s){var l=function(e){var t={};for(var n in e){var r=e[n];for(var o in r)if("meta"!=o){var a=r[o];t[o]="string"==typeof a?{title:a}:a}}return t}(a),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var o in n={},e){var a=e[o];t(a&&a.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+o+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+o+" because it is a component.");n[t]=o}))}return n[r]||r}}(l);i=i.map(c),s=(s||[]).map(c);var u=n(i),d=n(s);i.forEach((function e(n){var r=l[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(l),m=u;o(m);){for(var h in p={},m){var g=l[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var b in d)if(!(b in u))for(var y in f(b))if(y in u){p[b]=!0;break}for(var v in m=p)u[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,o){var a=o?o.series:void 0,i=o?o.parallel:e,s={},l={};function c(e){if(e in s)return s[e];l[e]=!0;var o,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)o=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete l[e],t})));a?o=a(p,(function(){return r(e)})):r(e)}return s[e]=o}for(var u in n)c(u);var d=[];for(var p in l)d.push(s[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},2694:(e,t,n)=>{"use strict";var r=n(6925);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},5556:(e,t,n)=>{e.exports=n(2694)()},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},2551:(e,t,n)=>{"use strict";var r=n(6540),o=n(9982);function a(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n