@bprotsyk/aso-core 2.1.13 → 2.1.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/docs/assets/highlight.css +22 -22
- package/docs/assets/main.js +58 -58
- package/docs/assets/style.css +1279 -1279
- package/docs/enums/PanelUserAccessScope.html +126 -126
- package/docs/functions/ASO_v0.toDefault.html +80 -80
- package/docs/functions/ASO_v1.toDefault.html +80 -80
- package/docs/functions/ASO_v2.toDefault.html +78 -78
- package/docs/functions/ASO_v3.toDefault.html +77 -77
- package/docs/functions/ASO_v4.toDefault.html +75 -75
- package/docs/functions/ASO_v5.toDefault.html +76 -76
- package/docs/functions/ColoredText.html +92 -92
- package/docs/functions/ShapeDiv.html +109 -109
- package/docs/index.html +82 -82
- package/docs/interfaces/ASOConfigFetch.IUsageLogEntry.html +1413 -1413
- package/docs/interfaces/ASOConfigFetch.IUsageLogRequest.html +103 -103
- package/docs/interfaces/ASOConfigFetch.IUsageLogResponse.html +108 -108
- package/docs/interfaces/ASO_v0.IAuthorizationActionMapping.html +145 -145
- package/docs/interfaces/ASO_v0.IColoredSpan.html +89 -89
- package/docs/interfaces/ASO_v0.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v0.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v0.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v0.IConfig.html +556 -556
- package/docs/interfaces/ASO_v0.IConfigMapping.html +229 -229
- package/docs/interfaces/ASO_v0.ILocalization.html +516 -516
- package/docs/interfaces/ASO_v0.ILocalizationMap.html +77 -77
- package/docs/interfaces/ASO_v0.ILocalizationMapping.html +502 -502
- package/docs/interfaces/ASO_v0.IOfferResult.html +103 -103
- package/docs/interfaces/ASO_v0.IOfferResultEmoji.html +82 -82
- package/docs/interfaces/ASO_v0.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v0.IOfferSectionMapping.html +108 -108
- package/docs/interfaces/ASO_v0.IOffersSection.html +96 -96
- package/docs/interfaces/ASO_v0.ISectionPalette.html +152 -152
- package/docs/interfaces/ASO_v0.ISectionPaletteMapping.html +152 -152
- package/docs/interfaces/ASO_v1.IAuthorizationActionMapping.html +145 -145
- package/docs/interfaces/ASO_v1.IColoredSpan.html +89 -89
- package/docs/interfaces/ASO_v1.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v1.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v1.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v1.IConfig.html +549 -549
- package/docs/interfaces/ASO_v1.IConfigMapping.html +229 -229
- package/docs/interfaces/ASO_v1.ILocalization.html +481 -481
- package/docs/interfaces/ASO_v1.ILocalizationMap.html +77 -77
- package/docs/interfaces/ASO_v1.ILocalizationMapping.html +481 -481
- package/docs/interfaces/ASO_v1.IOfferResult.html +103 -103
- package/docs/interfaces/ASO_v1.IOfferResultEmoji.html +82 -82
- package/docs/interfaces/ASO_v1.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v1.IOfferSectionMapping.html +108 -108
- package/docs/interfaces/ASO_v1.IOffersSection.html +101 -101
- package/docs/interfaces/ASO_v1.ISectionPalette.html +152 -152
- package/docs/interfaces/ASO_v1.ISectionPaletteMapping.html +152 -152
- package/docs/interfaces/ASO_v2.IAuthorizationActionMapping.html +138 -138
- package/docs/interfaces/ASO_v2.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v2.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v2.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v2.IConfig.html +493 -493
- package/docs/interfaces/ASO_v2.IConfigMapping.html +201 -201
- package/docs/interfaces/ASO_v2.ILocalization.html +474 -474
- package/docs/interfaces/ASO_v2.ILocalizationMap.html +75 -75
- package/docs/interfaces/ASO_v2.ILocalizationMapping.html +362 -362
- package/docs/interfaces/ASO_v2.IOfferResult.html +110 -110
- package/docs/interfaces/ASO_v2.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v2.IOfferSectionMapping.html +108 -108
- package/docs/interfaces/ASO_v2.IOffersSection.html +101 -101
- package/docs/interfaces/ASO_v2.ISectionPalette.html +152 -152
- package/docs/interfaces/ASO_v2.ISectionPaletteMapping.html +152 -152
- package/docs/interfaces/ASO_v3.IAuthorizationActionMapping.html +138 -138
- package/docs/interfaces/ASO_v3.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v3.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v3.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v3.IConfig.html +514 -514
- package/docs/interfaces/ASO_v3.IConfigMapping.html +208 -208
- package/docs/interfaces/ASO_v3.ILocalization.html +446 -446
- package/docs/interfaces/ASO_v3.ILocalizationMap.html +74 -74
- package/docs/interfaces/ASO_v3.ILocalizationMapping.html +341 -341
- package/docs/interfaces/ASO_v3.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v3.IOfferSectionMapping.html +108 -108
- package/docs/interfaces/ASO_v3.IOffersSection.html +101 -101
- package/docs/interfaces/ASO_v3.ISectionPalette.html +152 -152
- package/docs/interfaces/ASO_v3.ISectionPaletteMapping.html +152 -152
- package/docs/interfaces/ASO_v4.IAuthorizationActionMapping.html +138 -138
- package/docs/interfaces/ASO_v4.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v4.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v4.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v4.IConfig.html +514 -514
- package/docs/interfaces/ASO_v4.IConfigMapping.html +131 -131
- package/docs/interfaces/ASO_v4.ILocalization.html +369 -369
- package/docs/interfaces/ASO_v4.ILocalizationMap.html +72 -72
- package/docs/interfaces/ASO_v4.ILocalizationMapping.html +257 -257
- package/docs/interfaces/ASO_v4.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v4.IOfferSectionMapping.html +89 -89
- package/docs/interfaces/ASO_v4.LocalizedString.html +82 -82
- package/docs/interfaces/ASO_v5.IAuthorizationActionMapping.html +138 -138
- package/docs/interfaces/ASO_v5.IColoredSpan.html +89 -89
- package/docs/interfaces/ASO_v5.IColoredSpanMapping.html +89 -89
- package/docs/interfaces/ASO_v5.IColoredString.html +89 -89
- package/docs/interfaces/ASO_v5.IColoredStringMapping.html +89 -89
- package/docs/interfaces/ASO_v5.IConfig.html +542 -542
- package/docs/interfaces/ASO_v5.IConfigMapping.html +159 -159
- package/docs/interfaces/ASO_v5.ILocalization.html +411 -411
- package/docs/interfaces/ASO_v5.ILocalizationMap.html +73 -73
- package/docs/interfaces/ASO_v5.ILocalizationMapping.html +299 -299
- package/docs/interfaces/ASO_v5.IOfferResultMapping.html +117 -117
- package/docs/interfaces/ASO_v5.IOfferSectionMapping.html +89 -89
- package/docs/interfaces/ASO_v5.LocalizedString.html +82 -82
- package/docs/interfaces/IAsoConfigResponse.html +81 -81
- package/docs/interfaces/IAsoCustomizedOffer.html +116 -116
- package/docs/interfaces/IAsoDefaultConfig.html +443 -443
- package/docs/interfaces/IAsoOfferResponse.html +81 -81
- package/docs/interfaces/IAsoSection.html +88 -88
- package/docs/interfaces/IAsoSingleOffer.html +88 -88
- package/docs/interfaces/IAuthToken.html +102 -102
- package/docs/interfaces/IColoredTextProps.html +74 -74
- package/docs/interfaces/IFlashApp.html +144 -144
- package/docs/interfaces/IFlashAppListItem.html +88 -88
- package/docs/interfaces/IGradient.html +95 -95
- package/docs/interfaces/IOffer.html +137 -137
- package/docs/interfaces/IOfferWallAuthConfig.html +130 -130
- package/docs/interfaces/IOfferWallAuthLocalization.html +102 -102
- package/docs/interfaces/IOfferWallAuthSubmitRequest.html +74 -74
- package/docs/interfaces/IOfferWallAuthSubmitResponse.html +74 -74
- package/docs/interfaces/IOfferWallHomeDialogData.html +95 -95
- package/docs/interfaces/IOfferWallOffer.html +109 -109
- package/docs/interfaces/IOfferWallResponse.html +81 -81
- package/docs/interfaces/IOfferWallSection.html +88 -88
- package/docs/interfaces/IPanelUser.html +1405 -1405
- package/docs/interfaces/IPush.html +95 -95
- package/docs/interfaces/IShape.html +102 -102
- package/docs/interfaces/IStroke.html +81 -81
- package/docs/interfaces/IUpsertFlashAppRequest.html +214 -214
- package/docs/interfaces/IUpsertFlashAppResponse.html +81 -81
- package/docs/modules/ASOConfigFetch.html +63 -63
- package/docs/modules/ASO_v0.html +96 -96
- package/docs/modules/ASO_v1.html +96 -96
- package/docs/modules/ASO_v2.html +92 -92
- package/docs/modules/ASO_v3.html +90 -90
- package/docs/modules/ASO_v4.html +86 -86
- package/docs/modules/ASO_v5.html +88 -88
- package/docs/modules.html +133 -133
- package/docs/variables/FlashAppSchema.html +83 -83
- package/docs/variables/PanelUserSchema.html +83 -83
- package/lib/app/app-integration.d.ts +53 -53
- package/lib/app/app-integration.js +63 -63
- package/lib/app/app-list-item.d.ts +5 -5
- package/lib/app/app-list-item.js +2 -2
- package/lib/app/app-type.d.ts +4 -4
- package/lib/app/app-type.js +8 -8
- package/lib/app/app.d.ts +206 -206
- package/lib/app/app.js +173 -173
- package/lib/general/cloudflare-domain.d.ts +42 -42
- package/lib/general/cloudflare-domain.js +12 -12
- package/lib/general/domain.d.ts +108 -108
- package/lib/general/domain.js +61 -61
- package/lib/general/namecheap-domain.d.ts +85 -85
- package/lib/general/namecheap-domain.js +14 -14
- package/lib/general/push.d.ts +6 -6
- package/lib/general/push.js +2 -2
- package/lib/general/queue.d.ts +2 -2
- package/lib/general/queue.js +1 -1
- package/lib/general/shape.d.ts +18 -18
- package/lib/general/shape.js +36 -36
- package/lib/index.d.ts +26 -26
- package/lib/index.js +69 -69
- package/lib/keitaro/keitaro-campaign.d.ts +31 -31
- package/lib/keitaro/keitaro-campaign.js +5 -5
- package/lib/keitaro/keitaro-domain.d.ts +6 -6
- package/lib/keitaro/keitaro-domain.js +2 -2
- package/lib/keitaro/keitaro-offer.d.ts +7 -7
- package/lib/keitaro/keitaro-offer.js +2 -2
- package/lib/keitaro/keitaro-stream.d.ts +20 -20
- package/lib/keitaro/keitaro-stream.js +2 -2
- package/lib/network/keitaro/http.d.ts +2 -2
- package/lib/network/keitaro/http.js +12 -12
- package/lib/network/keitaro/keitaro-service.d.ts +50 -50
- package/lib/network/keitaro/keitaro-service.js +261 -260
- package/lib/offers/list.d.ts +37 -37
- package/lib/offers/list.js +12 -12
- package/lib/offers/offer.d.ts +91 -91
- package/lib/offers/offer.js +42 -42
- package/lib/offers/offerwall/offerwall-home-dialog-data.d.ts +6 -6
- package/lib/offers/offerwall/offerwall-home-dialog-data.js +2 -2
- package/lib/offers/offerwall/offerwall-offer.d.ts +12 -12
- package/lib/offers/offerwall/offerwall-offer.js +2 -2
- package/lib/offers/offerwall/offerwall-response.d.ts +6 -6
- package/lib/offers/offerwall/offerwall-response.js +2 -2
- package/lib/offers/offerwall/offerwall-section.d.ts +6 -6
- package/lib/offers/offerwall/offerwall-section.js +2 -2
- package/lib/offers/section.d.ts +47 -47
- package/lib/offers/section.js +20 -20
- package/lib/panel/auth.d.ts +9 -9
- package/lib/panel/auth.js +2 -2
- package/lib/panel/flash/upsert-flash-app-request.d.ts +29 -29
- package/lib/panel/flash/upsert-flash-app-request.js +2 -2
- package/lib/panel/user.d.ts +46 -46
- package/lib/panel/user.js +28 -28
- package/lib/templates/nginx-template.conf +35 -35
- package/lib/templates/nginx-template.d.ts +1 -1
- package/lib/templates/nginx-template.js +39 -39
- package/lib/templates/nginx-template.ts +35 -35
- package/lib/utils/general.d.ts +11 -11
- package/lib/utils/general.js +40 -40
- package/lib/utils/huawei/converter.d.ts +2 -2
- package/lib/utils/huawei/converter.js +53 -53
- package/lib/utils/keitaro-utils.d.ts +15 -15
- package/lib/utils/keitaro-utils.js +569 -541
- package/lib/utils/server-util.js +303 -303
- package/package.json +51 -51
- package/src/app/app-integration.ts +66 -66
- package/src/app/app-list-item.ts +4 -4
- package/src/app/app-type.ts +3 -3
- package/src/app/app.ts +333 -333
- package/src/general/cloudflare-domain.ts +44 -44
- package/src/general/domain.ts +105 -105
- package/src/general/namecheap-domain.ts +63 -63
- package/src/general/push.ts +5 -5
- package/src/general/queue.ts +4 -4
- package/src/general/shape.tsx +55 -55
- package/src/index.ts +32 -32
- package/src/keitaro/keitaro-campaign.ts +35 -35
- package/src/keitaro/keitaro-domain.ts +5 -5
- package/src/keitaro/keitaro-offer.ts +6 -6
- package/src/keitaro/keitaro-stream.ts +19 -19
- package/src/network/keitaro/http.ts +8 -8
- package/src/network/keitaro/keitaro-service.ts +323 -322
- package/src/offers/list.ts +19 -19
- package/src/offers/offer.ts +80 -80
- package/src/offers/offerwall/offerwall-home-dialog-data.ts +6 -6
- package/src/offers/offerwall/offerwall-offer.ts +12 -12
- package/src/offers/offerwall/offerwall-response.ts +7 -7
- package/src/offers/offerwall/offerwall-section.ts +7 -7
- package/src/offers/section.ts +29 -29
- package/src/panel/auth.ts +9 -9
- package/src/panel/flash/upsert-flash-app-request.ts +37 -37
- package/src/panel/user.ts +38 -38
- package/src/templates/nginx-template.ts +35 -35
- package/src/utils/data.csv +65 -65
- package/src/utils/general.ts +36 -36
- package/src/utils/huawei/converter.ts +55 -55
- package/src/utils/keitaro-utils.ts +661 -626
- package/src/utils/map-apps.json +4747 -4747
- package/src/utils/server-util.ts +368 -368
- package/src/utils/update-postbacks.js +27 -27
- package/tsconfig.json +20 -20
|
@@ -1,1406 +1,1406 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPanelUser | @bprotsyk/aso-core</title><meta name="description" content="Documentation for @bprotsyk/aso-core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
-
<div class="tsd-toolbar-contents container">
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
-
<div class="field">
|
|
6
|
-
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
-
<ul class="results">
|
|
8
|
-
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bprotsyk/aso-core</a></div>
|
|
10
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
-
<div class="container container-main">
|
|
12
|
-
<div class="col-8 col-content">
|
|
13
|
-
<div class="tsd-page-title">
|
|
14
|
-
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../modules.html">@bprotsyk/aso-core</a></li>
|
|
16
|
-
<li><a href="IPanelUser.html">IPanelUser</a></li></ul>
|
|
17
|
-
<h1>Interface IPanelUser</h1></div>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
19
|
-
<h4>Hierarchy</h4>
|
|
20
|
-
<ul class="tsd-hierarchy">
|
|
21
|
-
<li><span class="tsd-signature-type">Document</span>
|
|
22
|
-
<ul class="tsd-hierarchy">
|
|
23
|
-
<li><span class="target">IPanelUser</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
|
-
<ul>
|
|
25
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-20">src/panel/user.ts:20</a></li></ul></aside>
|
|
26
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
-
<section class="tsd-panel tsd-index-panel">
|
|
28
|
-
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
29
|
-
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
30
|
-
<div class="tsd-accordion-details">
|
|
31
|
-
<section class="tsd-index-section">
|
|
32
|
-
<h3 class="tsd-index-heading">Properties</h3>
|
|
33
|
-
<div class="tsd-index-list"><a href="IPanelUser.html#_locals" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>$locals</span></a>
|
|
34
|
-
<a href="IPanelUser.html#_op" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>$op</span></a>
|
|
35
|
-
<a href="IPanelUser.html#_where" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>$where</span></a>
|
|
36
|
-
<a href="IPanelUser.html#__v" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>__v?</span></a>
|
|
37
|
-
<a href="IPanelUser.html#_id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_id?</span></a>
|
|
38
|
-
<a href="IPanelUser.html#accessScopes" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>access<wbr/>Scopes</span></a>
|
|
39
|
-
<a href="IPanelUser.html#baseModelName" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>base<wbr/>Model<wbr/>Name?</span></a>
|
|
40
|
-
<a href="IPanelUser.html#collection" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>collection</span></a>
|
|
41
|
-
<a href="IPanelUser.html#db" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>db</span></a>
|
|
42
|
-
<a href="IPanelUser.html#errors" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>errors?</span></a>
|
|
43
|
-
<a href="IPanelUser.html#id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>id?</span></a>
|
|
44
|
-
<a href="IPanelUser.html#isNew" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>is<wbr/>New</span></a>
|
|
45
|
-
<a href="IPanelUser.html#passwordHash" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>password<wbr/>Hash</span></a>
|
|
46
|
-
<a href="IPanelUser.html#schema" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>schema</span></a>
|
|
47
|
-
<a href="IPanelUser.html#username" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>username</span></a>
|
|
48
|
-
</div></section>
|
|
49
|
-
<section class="tsd-index-section">
|
|
50
|
-
<h3 class="tsd-index-heading">Methods</h3>
|
|
51
|
-
<div class="tsd-index-list"><a href="IPanelUser.html#_assertPopulated" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>$assert<wbr/>Populated</span></a>
|
|
52
|
-
<a href="IPanelUser.html#_clone" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$clone</span></a>
|
|
53
|
-
<a href="IPanelUser.html#_getAllSubdocs" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$get<wbr/>All<wbr/>Subdocs</span></a>
|
|
54
|
-
<a href="IPanelUser.html#_getPopulatedDocs" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$get<wbr/>Populated<wbr/>Docs</span></a>
|
|
55
|
-
<a href="IPanelUser.html#_ignore" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$ignore</span></a>
|
|
56
|
-
<a href="IPanelUser.html#_inc" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$inc</span></a>
|
|
57
|
-
<a href="IPanelUser.html#_isDefault" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Default</span></a>
|
|
58
|
-
<a href="IPanelUser.html#_isDeleted" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Deleted</span></a>
|
|
59
|
-
<a href="IPanelUser.html#_isEmpty" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Empty</span></a>
|
|
60
|
-
<a href="IPanelUser.html#_isValid" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Valid</span></a>
|
|
61
|
-
<a href="IPanelUser.html#_markValid" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$mark<wbr/>Valid</span></a>
|
|
62
|
-
<a href="IPanelUser.html#_model" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$model</span></a>
|
|
63
|
-
<a href="IPanelUser.html#_parent" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$parent</span></a>
|
|
64
|
-
<a href="IPanelUser.html#_session" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$session</span></a>
|
|
65
|
-
<a href="IPanelUser.html#_set" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$set</span></a>
|
|
66
|
-
<a href="IPanelUser.html#delete" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete</span></a>
|
|
67
|
-
<a href="IPanelUser.html#deleteOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>One</span></a>
|
|
68
|
-
<a href="IPanelUser.html#depopulate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>depopulate</span></a>
|
|
69
|
-
<a href="IPanelUser.html#directModifiedPaths" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>direct<wbr/>Modified<wbr/>Paths</span></a>
|
|
70
|
-
<a href="IPanelUser.html#equals" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>equals</span></a>
|
|
71
|
-
<a href="IPanelUser.html#get" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get</span></a>
|
|
72
|
-
<a href="IPanelUser.html#getChanges" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Changes</span></a>
|
|
73
|
-
<a href="IPanelUser.html#increment" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>increment</span></a>
|
|
74
|
-
<a href="IPanelUser.html#init" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>init</span></a>
|
|
75
|
-
<a href="IPanelUser.html#invalidate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>invalidate</span></a>
|
|
76
|
-
<a href="IPanelUser.html#isDirectModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Direct<wbr/>Modified</span></a>
|
|
77
|
-
<a href="IPanelUser.html#isDirectSelected" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Direct<wbr/>Selected</span></a>
|
|
78
|
-
<a href="IPanelUser.html#isInit" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Init</span></a>
|
|
79
|
-
<a href="IPanelUser.html#isModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Modified</span></a>
|
|
80
|
-
<a href="IPanelUser.html#isSelected" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Selected</span></a>
|
|
81
|
-
<a href="IPanelUser.html#markModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>mark<wbr/>Modified</span></a>
|
|
82
|
-
<a href="IPanelUser.html#modifiedPaths" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>modified<wbr/>Paths</span></a>
|
|
83
|
-
<a href="IPanelUser.html#overwrite" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>overwrite</span></a>
|
|
84
|
-
<a href="IPanelUser.html#populate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>populate</span></a>
|
|
85
|
-
<a href="IPanelUser.html#populated" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>populated</span></a>
|
|
86
|
-
<a href="IPanelUser.html#remove" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove</span></a>
|
|
87
|
-
<a href="IPanelUser.html#replaceOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>replace<wbr/>One</span></a>
|
|
88
|
-
<a href="IPanelUser.html#save" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save</span></a>
|
|
89
|
-
<a href="IPanelUser.html#set" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set</span></a>
|
|
90
|
-
<a href="IPanelUser.html#toJSON" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>toJSON</span></a>
|
|
91
|
-
<a href="IPanelUser.html#toObject" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>Object</span></a>
|
|
92
|
-
<a href="IPanelUser.html#unmarkModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unmark<wbr/>Modified</span></a>
|
|
93
|
-
<a href="IPanelUser.html#update" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update</span></a>
|
|
94
|
-
<a href="IPanelUser.html#updateOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>One</span></a>
|
|
95
|
-
<a href="IPanelUser.html#validate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate</span></a>
|
|
96
|
-
<a href="IPanelUser.html#validateSync" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Sync</span></a>
|
|
97
|
-
</div></section></div></details></section></section>
|
|
98
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
99
|
-
<h2>Properties</h2>
|
|
100
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_locals" class="tsd-anchor"></a>
|
|
101
|
-
<h3 class="tsd-anchor-link"><span>$locals</span><a href="#_locals" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
102
|
-
<div class="tsd-signature">$locals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div>
|
|
103
|
-
<div class="tsd-comment tsd-typography"><p>Empty object that you can use for storing properties on the document. This
|
|
104
|
-
is handy for passing data to middleware without conflicting with Mongoose
|
|
105
|
-
internals.</p>
|
|
106
|
-
</div><aside class="tsd-sources">
|
|
107
|
-
<p>Inherited from Document.$locals</p>
|
|
108
|
-
<ul>
|
|
109
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-71">node_modules/mongoose/types/document.d.ts:71</a></li></ul></aside></section>
|
|
110
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_op" class="tsd-anchor"></a>
|
|
111
|
-
<h3 class="tsd-anchor-link"><span>$op</span><a href="#_op" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
112
|
-
<div class="tsd-signature">$op<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"remove"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"save"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"validate"</span></div>
|
|
113
|
-
<div class="tsd-comment tsd-typography"><p>A string containing the current operation that Mongoose is executing
|
|
114
|
-
on this document. Can be <code>null</code>, <code>'save'</code>, <code>'validate'</code>, or <code>'remove'</code>.</p>
|
|
115
|
-
</div><aside class="tsd-sources">
|
|
116
|
-
<p>Inherited from Document.$op</p>
|
|
117
|
-
<ul>
|
|
118
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-83">node_modules/mongoose/types/document.d.ts:83</a></li></ul></aside></section>
|
|
119
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_where" class="tsd-anchor"></a>
|
|
120
|
-
<h3 class="tsd-anchor-link"><span>$where</span><a href="#_where" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
121
|
-
<div class="tsd-signature">$where<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div>
|
|
122
|
-
<div class="tsd-comment tsd-typography"><p>Set this property to add additional query filters when Mongoose saves this document and <code>isNew</code> is false.</p>
|
|
123
|
-
</div><aside class="tsd-sources">
|
|
124
|
-
<p>Inherited from Document.$where</p>
|
|
125
|
-
<ul>
|
|
126
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-98">node_modules/mongoose/types/document.d.ts:98</a></li></ul></aside></section>
|
|
127
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="__v" class="tsd-anchor"></a>
|
|
128
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>__v</span><a href="#__v" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
129
|
-
<div class="tsd-signature">__v<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
130
|
-
<div class="tsd-comment tsd-typography"><p>This documents __v.</p>
|
|
131
|
-
</div><aside class="tsd-sources">
|
|
132
|
-
<p>Inherited from Document.__v</p>
|
|
133
|
-
<ul>
|
|
134
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-26">node_modules/mongoose/types/document.d.ts:26</a></li></ul></aside></section>
|
|
135
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_id" class="tsd-anchor"></a>
|
|
136
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>_id</span><a href="#_id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
137
|
-
<div class="tsd-signature">_id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
138
|
-
<div class="tsd-comment tsd-typography"><p>This documents _id.</p>
|
|
139
|
-
</div><aside class="tsd-sources">
|
|
140
|
-
<p>Inherited from Document._id</p>
|
|
141
|
-
<ul>
|
|
142
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-23">node_modules/mongoose/types/document.d.ts:23</a></li></ul></aside></section>
|
|
143
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="accessScopes" class="tsd-anchor"></a>
|
|
144
|
-
<h3 class="tsd-anchor-link"><span>access<wbr/>Scopes</span><a href="#accessScopes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
145
|
-
<div class="tsd-signature">access<wbr/>Scopes<span class="tsd-signature-symbol">:</span> <a href="../enums/PanelUserAccessScope.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PanelUserAccessScope</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
146
|
-
<ul>
|
|
147
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-23">src/panel/user.ts:23</a></li></ul></aside></section>
|
|
148
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="baseModelName" class="tsd-anchor"></a>
|
|
149
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Model<wbr/>Name</span><a href="#baseModelName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
150
|
-
<div class="tsd-signature">base<wbr/>Model<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
151
|
-
<div class="tsd-comment tsd-typography"><p>If this is a discriminator model, <code>baseModelName</code> is the name of the base model.</p>
|
|
152
|
-
</div><aside class="tsd-sources">
|
|
153
|
-
<p>Inherited from Document.baseModelName</p>
|
|
154
|
-
<ul>
|
|
155
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-101">node_modules/mongoose/types/document.d.ts:101</a></li></ul></aside></section>
|
|
156
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="collection" class="tsd-anchor"></a>
|
|
157
|
-
<h3 class="tsd-anchor-link"><span>collection</span><a href="#collection" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
158
|
-
<div class="tsd-signature">collection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Collection</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">></span></div>
|
|
159
|
-
<div class="tsd-comment tsd-typography"><p>Collection the model uses.</p>
|
|
160
|
-
</div><aside class="tsd-sources">
|
|
161
|
-
<p>Inherited from Document.collection</p>
|
|
162
|
-
<ul>
|
|
163
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-104">node_modules/mongoose/types/document.d.ts:104</a></li></ul></aside></section>
|
|
164
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="db" class="tsd-anchor"></a>
|
|
165
|
-
<h3 class="tsd-anchor-link"><span>db</span><a href="#db" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
166
|
-
<div class="tsd-signature">db<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div>
|
|
167
|
-
<div class="tsd-comment tsd-typography"><p>Connection the model uses.</p>
|
|
168
|
-
</div><aside class="tsd-sources">
|
|
169
|
-
<p>Inherited from Document.db</p>
|
|
170
|
-
<ul>
|
|
171
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-107">node_modules/mongoose/types/document.d.ts:107</a></li></ul></aside></section>
|
|
172
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="errors" class="tsd-anchor"></a>
|
|
173
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>errors</span><a href="#errors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
174
|
-
<div class="tsd-signature">errors<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ValidationError</span></div>
|
|
175
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current validation errors.</p>
|
|
176
|
-
</div><aside class="tsd-sources">
|
|
177
|
-
<p>Inherited from Document.errors</p>
|
|
178
|
-
<ul>
|
|
179
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-142">node_modules/mongoose/types/document.d.ts:142</a></li></ul></aside></section>
|
|
180
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="id" class="tsd-anchor"></a>
|
|
181
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
182
|
-
<div class="tsd-signature">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
183
|
-
<div class="tsd-comment tsd-typography"><p>The string version of this documents _id.</p>
|
|
184
|
-
</div><aside class="tsd-sources">
|
|
185
|
-
<p>Inherited from Document.id</p>
|
|
186
|
-
<ul>
|
|
187
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-154">node_modules/mongoose/types/document.d.ts:154</a></li></ul></aside></section>
|
|
188
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isNew" class="tsd-anchor"></a>
|
|
189
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>New</span><a href="#isNew" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
190
|
-
<div class="tsd-signature">is<wbr/>New<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
191
|
-
<div class="tsd-comment tsd-typography"><p>Boolean flag specifying if the document is new.</p>
|
|
192
|
-
</div><aside class="tsd-sources">
|
|
193
|
-
<p>Inherited from Document.isNew</p>
|
|
194
|
-
<ul>
|
|
195
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-185">node_modules/mongoose/types/document.d.ts:185</a></li></ul></aside></section>
|
|
196
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="passwordHash" class="tsd-anchor"></a>
|
|
197
|
-
<h3 class="tsd-anchor-link"><span>password<wbr/>Hash</span><a href="#passwordHash" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
198
|
-
<div class="tsd-signature">password<wbr/>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
199
|
-
<ul>
|
|
200
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-22">src/panel/user.ts:22</a></li></ul></aside></section>
|
|
201
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="schema" class="tsd-anchor"></a>
|
|
202
|
-
<h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
203
|
-
<div class="tsd-signature">schema<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Schema</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultSchemaOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></div>
|
|
204
|
-
<div class="tsd-comment tsd-typography"><p>The document's schema.</p>
|
|
205
|
-
</div><aside class="tsd-sources">
|
|
206
|
-
<p>Inherited from Document.schema</p>
|
|
207
|
-
<ul>
|
|
208
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-232">node_modules/mongoose/types/document.d.ts:232</a></li></ul></aside></section>
|
|
209
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="username" class="tsd-anchor"></a>
|
|
210
|
-
<h3 class="tsd-anchor-link"><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
211
|
-
<div class="tsd-signature">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
212
|
-
<ul>
|
|
213
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-21">src/panel/user.ts:21</a></li></ul></aside></section></section>
|
|
214
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
215
|
-
<h2>Methods</h2>
|
|
216
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_assertPopulated" class="tsd-anchor"></a>
|
|
217
|
-
<h3 class="tsd-anchor-link"><span>$assert<wbr/>Populated</span><a href="#_assertPopulated" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
218
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
219
|
-
<li class="tsd-signature tsd-anchor-link" id="_assertPopulated._assertPopulated-1">$assert<wbr/>Populated<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, values<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><a href="#_assertPopulated._assertPopulated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
220
|
-
<li class="tsd-description">
|
|
221
|
-
<div class="tsd-comment tsd-typography"><p>Assert that a given path or paths is populated. Throws an error if not populated.</p>
|
|
222
|
-
</div>
|
|
223
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
224
|
-
<h4>Type Parameters</h4>
|
|
225
|
-
<ul class="tsd-type-parameters">
|
|
226
|
-
<li>
|
|
227
|
-
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
228
|
-
<div class="tsd-parameters">
|
|
229
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
230
|
-
<ul class="tsd-parameter-list">
|
|
231
|
-
<li>
|
|
232
|
-
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
233
|
-
<li>
|
|
234
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> values: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
235
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span></h4><aside class="tsd-sources">
|
|
236
|
-
<p>Inherited from Document.$assertPopulated</p>
|
|
237
|
-
<ul>
|
|
238
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-29">node_modules/mongoose/types/document.d.ts:29</a></li></ul></aside></li></ul></section>
|
|
239
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_clone" class="tsd-anchor"></a>
|
|
240
|
-
<h3 class="tsd-anchor-link"><span>$clone</span><a href="#_clone" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
241
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
242
|
-
<li class="tsd-signature tsd-anchor-link" id="_clone._clone-1">$clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_clone._clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
243
|
-
<li class="tsd-description">
|
|
244
|
-
<div class="tsd-comment tsd-typography"><p>Returns a deep clone of this document</p>
|
|
245
|
-
</div>
|
|
246
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
247
|
-
<p>Inherited from Document.$clone</p>
|
|
248
|
-
<ul>
|
|
249
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-32">node_modules/mongoose/types/document.d.ts:32</a></li></ul></aside></li></ul></section>
|
|
250
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_getAllSubdocs" class="tsd-anchor"></a>
|
|
251
|
-
<h3 class="tsd-anchor-link"><span>$get<wbr/>All<wbr/>Subdocs</span><a href="#_getAllSubdocs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
252
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
253
|
-
<li class="tsd-signature tsd-anchor-link" id="_getAllSubdocs._getAllSubdocs-1">$get<wbr/>All<wbr/>Subdocs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#_getAllSubdocs._getAllSubdocs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
254
|
-
<li class="tsd-description">
|
|
255
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
256
|
-
<p>Inherited from Document.$getAllSubdocs</p>
|
|
257
|
-
<ul>
|
|
258
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-35">node_modules/mongoose/types/document.d.ts:35</a></li></ul></aside></li></ul></section>
|
|
259
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_getPopulatedDocs" class="tsd-anchor"></a>
|
|
260
|
-
<h3 class="tsd-anchor-link"><span>$get<wbr/>Populated<wbr/>Docs</span><a href="#_getPopulatedDocs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
261
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
262
|
-
<li class="tsd-signature tsd-anchor-link" id="_getPopulatedDocs._getPopulatedDocs-1">$get<wbr/>Populated<wbr/>Docs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#_getPopulatedDocs._getPopulatedDocs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
263
|
-
<li class="tsd-description">
|
|
264
|
-
<div class="tsd-comment tsd-typography"><p>Returns an array of all populated documents associated with the query</p>
|
|
265
|
-
</div>
|
|
266
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
267
|
-
<p>Inherited from Document.$getPopulatedDocs</p>
|
|
268
|
-
<ul>
|
|
269
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-47">node_modules/mongoose/types/document.d.ts:47</a></li></ul></aside></li></ul></section>
|
|
270
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_ignore" class="tsd-anchor"></a>
|
|
271
|
-
<h3 class="tsd-anchor-link"><span>$ignore</span><a href="#_ignore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
272
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
273
|
-
<li class="tsd-signature tsd-anchor-link" id="_ignore._ignore-1">$ignore<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_ignore._ignore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
274
|
-
<li class="tsd-description">
|
|
275
|
-
<div class="tsd-comment tsd-typography"><p>Don't run validation on this path or persist changes to this path.</p>
|
|
276
|
-
</div>
|
|
277
|
-
<div class="tsd-parameters">
|
|
278
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
279
|
-
<ul class="tsd-parameter-list">
|
|
280
|
-
<li>
|
|
281
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
282
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
283
|
-
<p>Inherited from Document.$ignore</p>
|
|
284
|
-
<ul>
|
|
285
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-38">node_modules/mongoose/types/document.d.ts:38</a></li></ul></aside></li></ul></section>
|
|
286
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_inc" class="tsd-anchor"></a>
|
|
287
|
-
<h3 class="tsd-anchor-link"><span>$inc</span><a href="#_inc" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
288
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
289
|
-
<li class="tsd-signature tsd-anchor-link" id="_inc._inc-1">$inc<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, val<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_inc._inc-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
290
|
-
<li class="tsd-description">
|
|
291
|
-
<div class="tsd-comment tsd-typography"><p>Increments the numeric value at <code>path</code> by the given <code>val</code>.
|
|
292
|
-
When you call <code>save()</code> on this document, Mongoose will send a
|
|
293
|
-
<code>$inc</code> as opposed to a <code>$set</code>.</p>
|
|
294
|
-
</div>
|
|
295
|
-
<div class="tsd-parameters">
|
|
296
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
297
|
-
<ul class="tsd-parameter-list">
|
|
298
|
-
<li>
|
|
299
|
-
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
300
|
-
<li>
|
|
301
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> val: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
|
302
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
303
|
-
<p>Inherited from Document.$inc</p>
|
|
304
|
-
<ul>
|
|
305
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-54">node_modules/mongoose/types/document.d.ts:54</a></li></ul></aside></li></ul></section>
|
|
306
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isDefault" class="tsd-anchor"></a>
|
|
307
|
-
<h3 class="tsd-anchor-link"><span>$is<wbr/>Default</span><a href="#_isDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
308
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
309
|
-
<li class="tsd-signature tsd-anchor-link" id="_isDefault._isDefault-1">$is<wbr/>Default<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isDefault._isDefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
310
|
-
<li class="tsd-description">
|
|
311
|
-
<div class="tsd-comment tsd-typography"><p>Checks if a path is set to its default.</p>
|
|
312
|
-
</div>
|
|
313
|
-
<div class="tsd-parameters">
|
|
314
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
315
|
-
<ul class="tsd-parameter-list">
|
|
316
|
-
<li>
|
|
317
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
318
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
319
|
-
<p>Inherited from Document.$isDefault</p>
|
|
320
|
-
<ul>
|
|
321
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-41">node_modules/mongoose/types/document.d.ts:41</a></li></ul></aside></li></ul></section>
|
|
322
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isDeleted" class="tsd-anchor"></a>
|
|
323
|
-
<h3 class="tsd-anchor-link"><span>$is<wbr/>Deleted</span><a href="#_isDeleted" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
324
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
325
|
-
<li class="tsd-signature tsd-anchor-link" id="_isDeleted._isDeleted-1">$is<wbr/>Deleted<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isDeleted._isDeleted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
326
|
-
<li class="tsd-description">
|
|
327
|
-
<div class="tsd-comment tsd-typography"><p>Getter/setter, determines whether the document was removed or not.</p>
|
|
328
|
-
</div>
|
|
329
|
-
<div class="tsd-parameters">
|
|
330
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
331
|
-
<ul class="tsd-parameter-list">
|
|
332
|
-
<li>
|
|
333
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> val: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
334
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
335
|
-
<p>Inherited from Document.$isDeleted</p>
|
|
336
|
-
<ul>
|
|
337
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-44">node_modules/mongoose/types/document.d.ts:44</a></li></ul></aside></li></ul></section>
|
|
338
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isEmpty" class="tsd-anchor"></a>
|
|
339
|
-
<h3 class="tsd-anchor-link"><span>$is<wbr/>Empty</span><a href="#_isEmpty" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
340
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
341
|
-
<li class="tsd-signature tsd-anchor-link" id="_isEmpty._isEmpty-1">$is<wbr/>Empty<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isEmpty._isEmpty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
342
|
-
<li class="tsd-description">
|
|
343
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if the given path is nullish or only contains empty objects.
|
|
344
|
-
Useful for determining whether this subdoc will get stripped out by the
|
|
345
|
-
<a href="/docs/guide.html#minimize">minimize option</a>.</p>
|
|
346
|
-
</div>
|
|
347
|
-
<div class="tsd-parameters">
|
|
348
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
349
|
-
<ul class="tsd-parameter-list">
|
|
350
|
-
<li>
|
|
351
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
352
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
353
|
-
<p>Inherited from Document.$isEmpty</p>
|
|
354
|
-
<ul>
|
|
355
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-61">node_modules/mongoose/types/document.d.ts:61</a></li></ul></aside></li></ul></section>
|
|
356
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isValid" class="tsd-anchor"></a>
|
|
357
|
-
<h3 class="tsd-anchor-link"><span>$is<wbr/>Valid</span><a href="#_isValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
358
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
359
|
-
<li class="tsd-signature tsd-anchor-link" id="_isValid._isValid-1">$is<wbr/>Valid<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isValid._isValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
360
|
-
<li class="tsd-description">
|
|
361
|
-
<div class="tsd-comment tsd-typography"><p>Checks if a path is invalid</p>
|
|
362
|
-
</div>
|
|
363
|
-
<div class="tsd-parameters">
|
|
364
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
365
|
-
<ul class="tsd-parameter-list">
|
|
366
|
-
<li>
|
|
367
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
368
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
369
|
-
<p>Inherited from Document.$isValid</p>
|
|
370
|
-
<ul>
|
|
371
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-64">node_modules/mongoose/types/document.d.ts:64</a></li></ul></aside></li></ul></section>
|
|
372
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_markValid" class="tsd-anchor"></a>
|
|
373
|
-
<h3 class="tsd-anchor-link"><span>$mark<wbr/>Valid</span><a href="#_markValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
374
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
375
|
-
<li class="tsd-signature tsd-anchor-link" id="_markValid._markValid-1">$mark<wbr/>Valid<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_markValid._markValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
376
|
-
<li class="tsd-description">
|
|
377
|
-
<div class="tsd-comment tsd-typography"><p>Marks a path as valid, removing existing validation errors.</p>
|
|
378
|
-
</div>
|
|
379
|
-
<div class="tsd-parameters">
|
|
380
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
381
|
-
<ul class="tsd-parameter-list">
|
|
382
|
-
<li>
|
|
383
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
384
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
385
|
-
<p>Inherited from Document.$markValid</p>
|
|
386
|
-
<ul>
|
|
387
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-74">node_modules/mongoose/types/document.d.ts:74</a></li></ul></aside></li></ul></section>
|
|
388
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_model" class="tsd-anchor"></a>
|
|
389
|
-
<h3 class="tsd-anchor-link"><span>$model</span><a href="#_model" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
390
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
391
|
-
<li class="tsd-signature tsd-anchor-link" id="_model._model-1">$model<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span><a href="#_model._model-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
392
|
-
<li class="tsd-description">
|
|
393
|
-
<div class="tsd-comment tsd-typography"><p>Returns the model with the given name on this document's associated connection.</p>
|
|
394
|
-
</div>
|
|
395
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
396
|
-
<h4>Type Parameters</h4>
|
|
397
|
-
<ul class="tsd-type-parameters">
|
|
398
|
-
<li>
|
|
399
|
-
<h4>ModelType = <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
400
|
-
<div class="tsd-parameters">
|
|
401
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
402
|
-
<ul class="tsd-parameter-list">
|
|
403
|
-
<li>
|
|
404
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
405
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span></h4><aside class="tsd-sources">
|
|
406
|
-
<p>Inherited from Document.$model</p>
|
|
407
|
-
<ul>
|
|
408
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-77">node_modules/mongoose/types/document.d.ts:77</a></li></ul></aside></li></ul></section>
|
|
409
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_parent" class="tsd-anchor"></a>
|
|
410
|
-
<h3 class="tsd-anchor-link"><span>$parent</span><a href="#_parent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
411
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
412
|
-
<li class="tsd-signature tsd-anchor-link" id="_parent._parent-1">$parent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#_parent._parent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
413
|
-
<li class="tsd-description">
|
|
414
|
-
<div class="tsd-comment tsd-typography"><p>If this document is a subdocument or populated document, returns the
|
|
415
|
-
document's parent. Returns undefined otherwise.</p>
|
|
416
|
-
</div>
|
|
417
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
418
|
-
<p>Inherited from Document.$parent</p>
|
|
419
|
-
<ul>
|
|
420
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-207">node_modules/mongoose/types/document.d.ts:207</a></li></ul></aside></li></ul></section>
|
|
421
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_session" class="tsd-anchor"></a>
|
|
422
|
-
<h3 class="tsd-anchor-link"><span>$session</span><a href="#_session" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
423
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
424
|
-
<li class="tsd-signature tsd-anchor-link" id="_session._session-1">$session<span class="tsd-signature-symbol">(</span>session<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span><a href="#_session._session-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
425
|
-
<li class="tsd-description">
|
|
426
|
-
<div class="tsd-comment tsd-typography"><p>Getter/setter around the session associated with this document. Used to
|
|
427
|
-
automatically set <code>session</code> if you <code>save()</code> a doc that you got from a
|
|
428
|
-
query with an associated session.</p>
|
|
429
|
-
</div>
|
|
430
|
-
<div class="tsd-parameters">
|
|
431
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
432
|
-
<ul class="tsd-parameter-list">
|
|
433
|
-
<li>
|
|
434
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> session: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span></h5></li></ul></div>
|
|
435
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span></h4><aside class="tsd-sources">
|
|
436
|
-
<p>Inherited from Document.$session</p>
|
|
437
|
-
<ul>
|
|
438
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-90">node_modules/mongoose/types/document.d.ts:90</a></li></ul></aside></li></ul></section>
|
|
439
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_set" class="tsd-anchor"></a>
|
|
440
|
-
<h3 class="tsd-anchor-link"><span>$set</span><a href="#_set" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
441
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
442
|
-
<li class="tsd-signature tsd-anchor-link" id="_set._set-1">$set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DocumentSetOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
443
|
-
<li class="tsd-description">
|
|
444
|
-
<div class="tsd-comment tsd-typography"><p>Alias for <code>set()</code>, used internally to avoid conflicts</p>
|
|
445
|
-
</div>
|
|
446
|
-
<div class="tsd-parameters">
|
|
447
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
448
|
-
<ul class="tsd-parameter-list">
|
|
449
|
-
<li>
|
|
450
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
451
|
-
<li>
|
|
452
|
-
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
453
|
-
<li>
|
|
454
|
-
<h5>type: <span class="tsd-signature-type">any</span></h5></li>
|
|
455
|
-
<li>
|
|
456
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">DocumentSetOptions</span></h5></li></ul></div>
|
|
457
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
458
|
-
<p>Inherited from Document.$set</p>
|
|
459
|
-
<ul>
|
|
460
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-93">node_modules/mongoose/types/document.d.ts:93</a></li></ul></aside></li>
|
|
461
|
-
<li class="tsd-signature tsd-anchor-link" id="_set._set-2">$set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DocumentSetOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
462
|
-
<li class="tsd-description">
|
|
463
|
-
<div class="tsd-parameters">
|
|
464
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
465
|
-
<ul class="tsd-parameter-list">
|
|
466
|
-
<li>
|
|
467
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
468
|
-
<li>
|
|
469
|
-
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
470
|
-
<li>
|
|
471
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">DocumentSetOptions</span></h5></li></ul></div>
|
|
472
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
473
|
-
<p>Inherited from Document.$set</p>
|
|
474
|
-
<ul>
|
|
475
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-94">node_modules/mongoose/types/document.d.ts:94</a></li></ul></aside></li>
|
|
476
|
-
<li class="tsd-signature tsd-anchor-link" id="_set._set-3">$set<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
477
|
-
<li class="tsd-description">
|
|
478
|
-
<div class="tsd-parameters">
|
|
479
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
480
|
-
<ul class="tsd-parameter-list">
|
|
481
|
-
<li>
|
|
482
|
-
<h5>value: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
483
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
484
|
-
<p>Inherited from Document.$set</p>
|
|
485
|
-
<ul>
|
|
486
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-95">node_modules/mongoose/types/document.d.ts:95</a></li></ul></aside></li></ul></section>
|
|
487
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="delete" class="tsd-anchor"></a>
|
|
488
|
-
<h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
489
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
490
|
-
<li class="tsd-signature tsd-anchor-link" id="delete.delete-1">delete<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
491
|
-
<li class="tsd-description">
|
|
492
|
-
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
493
|
-
</div>
|
|
494
|
-
<div class="tsd-parameters">
|
|
495
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
496
|
-
<ul class="tsd-parameter-list">
|
|
497
|
-
<li>
|
|
498
|
-
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
499
|
-
<li>
|
|
500
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
501
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
502
|
-
<p>Inherited from Document.delete</p>
|
|
503
|
-
<ul>
|
|
504
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-110">node_modules/mongoose/types/document.d.ts:110</a></li></ul></aside></li>
|
|
505
|
-
<li class="tsd-signature tsd-anchor-link" id="delete.delete-2">delete<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#delete.delete-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
506
|
-
<li class="tsd-description">
|
|
507
|
-
<div class="tsd-parameters">
|
|
508
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
509
|
-
<ul class="tsd-parameter-list">
|
|
510
|
-
<li>
|
|
511
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
512
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
513
|
-
<p>Inherited from Document.delete</p>
|
|
514
|
-
<ul>
|
|
515
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-111">node_modules/mongoose/types/document.d.ts:111</a></li></ul></aside></li>
|
|
516
|
-
<li class="tsd-signature tsd-anchor-link" id="delete.delete-3">delete<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#delete.delete-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
517
|
-
<li class="tsd-description">
|
|
518
|
-
<div class="tsd-parameters">
|
|
519
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
520
|
-
<ul class="tsd-parameter-list">
|
|
521
|
-
<li>
|
|
522
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
523
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
524
|
-
<p>Inherited from Document.delete</p>
|
|
525
|
-
<ul>
|
|
526
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-112">node_modules/mongoose/types/document.d.ts:112</a></li></ul></aside></li></ul></section>
|
|
527
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="deleteOne" class="tsd-anchor"></a>
|
|
528
|
-
<h3 class="tsd-anchor-link"><span>delete<wbr/>One</span><a href="#deleteOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
529
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
530
|
-
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-1">delete<wbr/>One<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteOne.deleteOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
531
|
-
<li class="tsd-description">
|
|
532
|
-
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
533
|
-
</div>
|
|
534
|
-
<div class="tsd-parameters">
|
|
535
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
536
|
-
<ul class="tsd-parameter-list">
|
|
537
|
-
<li>
|
|
538
|
-
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
539
|
-
<li>
|
|
540
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
541
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
542
|
-
<p>Inherited from Document.deleteOne</p>
|
|
543
|
-
<ul>
|
|
544
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-115">node_modules/mongoose/types/document.d.ts:115</a></li></ul></aside></li>
|
|
545
|
-
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-2">delete<wbr/>One<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteOne.deleteOne-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
546
|
-
<li class="tsd-description">
|
|
547
|
-
<div class="tsd-parameters">
|
|
548
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
549
|
-
<ul class="tsd-parameter-list">
|
|
550
|
-
<li>
|
|
551
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
552
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
553
|
-
<p>Inherited from Document.deleteOne</p>
|
|
554
|
-
<ul>
|
|
555
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-116">node_modules/mongoose/types/document.d.ts:116</a></li></ul></aside></li>
|
|
556
|
-
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-3">delete<wbr/>One<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#deleteOne.deleteOne-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
557
|
-
<li class="tsd-description">
|
|
558
|
-
<div class="tsd-parameters">
|
|
559
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
560
|
-
<ul class="tsd-parameter-list">
|
|
561
|
-
<li>
|
|
562
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
563
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
564
|
-
<p>Inherited from Document.deleteOne</p>
|
|
565
|
-
<ul>
|
|
566
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-117">node_modules/mongoose/types/document.d.ts:117</a></li></ul></aside></li></ul></section>
|
|
567
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="depopulate" class="tsd-anchor"></a>
|
|
568
|
-
<h3 class="tsd-anchor-link"><span>depopulate</span><a href="#depopulate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
569
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
570
|
-
<li class="tsd-signature tsd-anchor-link" id="depopulate.depopulate-1">depopulate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#depopulate.depopulate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
571
|
-
<li class="tsd-description">
|
|
572
|
-
<div class="tsd-comment tsd-typography"><p>Takes a populated field and returns it to its unpopulated state. If called with
|
|
573
|
-
no arguments, then all populated fields are returned to their unpopulated state.</p>
|
|
574
|
-
</div>
|
|
575
|
-
<div class="tsd-parameters">
|
|
576
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
577
|
-
<ul class="tsd-parameter-list">
|
|
578
|
-
<li>
|
|
579
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
580
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
581
|
-
<p>Inherited from Document.depopulate</p>
|
|
582
|
-
<ul>
|
|
583
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-123">node_modules/mongoose/types/document.d.ts:123</a></li></ul></aside></li></ul></section>
|
|
584
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="directModifiedPaths" class="tsd-anchor"></a>
|
|
585
|
-
<h3 class="tsd-anchor-link"><span>direct<wbr/>Modified<wbr/>Paths</span><a href="#directModifiedPaths" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
586
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
587
|
-
<li class="tsd-signature tsd-anchor-link" id="directModifiedPaths.directModifiedPaths-1">direct<wbr/>Modified<wbr/>Paths<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#directModifiedPaths.directModifiedPaths-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
588
|
-
<li class="tsd-description">
|
|
589
|
-
<div class="tsd-comment tsd-typography"><p>Returns the list of paths that have been directly modified. A direct
|
|
590
|
-
modified path is a path that you explicitly set, whether via <code>doc.foo = 'bar'</code>,
|
|
591
|
-
<code>Object.assign(doc, { foo: 'bar' })</code>, or <code>doc.set('foo', 'bar')</code>.</p>
|
|
592
|
-
</div>
|
|
593
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
594
|
-
<p>Inherited from Document.directModifiedPaths</p>
|
|
595
|
-
<ul>
|
|
596
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-130">node_modules/mongoose/types/document.d.ts:130</a></li></ul></aside></li></ul></section>
|
|
597
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="equals" class="tsd-anchor"></a>
|
|
598
|
-
<h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
599
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
600
|
-
<li class="tsd-signature tsd-anchor-link" id="equals.equals-1">equals<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
601
|
-
<li class="tsd-description">
|
|
602
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if this document is equal to another document.</p>
|
|
603
|
-
<p>Documents are considered equal when they have matching <code>_id</code>s, unless neither
|
|
604
|
-
document has an <code>_id</code>, in which case this function falls back to using
|
|
605
|
-
<code>deepEqual()</code>.</p>
|
|
606
|
-
</div>
|
|
607
|
-
<div class="tsd-parameters">
|
|
608
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
609
|
-
<ul class="tsd-parameter-list">
|
|
610
|
-
<li>
|
|
611
|
-
<h5>doc: <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
612
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
613
|
-
<p>Inherited from Document.equals</p>
|
|
614
|
-
<ul>
|
|
615
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-139">node_modules/mongoose/types/document.d.ts:139</a></li></ul></aside></li></ul></section>
|
|
616
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="get" class="tsd-anchor"></a>
|
|
617
|
-
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
618
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
619
|
-
<li class="tsd-signature tsd-anchor-link" id="get.get-1">get<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
620
|
-
<li class="tsd-description">
|
|
621
|
-
<div class="tsd-comment tsd-typography"><p>Returns the value of a path.</p>
|
|
622
|
-
</div>
|
|
623
|
-
<div class="tsd-parameters">
|
|
624
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
625
|
-
<ul class="tsd-parameter-list">
|
|
626
|
-
<li>
|
|
627
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
628
|
-
<li>
|
|
629
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> type: <span class="tsd-signature-type">any</span></h5></li>
|
|
630
|
-
<li>
|
|
631
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
632
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
633
|
-
<p>Inherited from Document.get</p>
|
|
634
|
-
<ul>
|
|
635
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-145">node_modules/mongoose/types/document.d.ts:145</a></li></ul></aside></li></ul></section>
|
|
636
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="getChanges" class="tsd-anchor"></a>
|
|
637
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Changes</span><a href="#getChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
638
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
639
|
-
<li class="tsd-signature tsd-anchor-link" id="getChanges.getChanges-1">get<wbr/>Changes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#getChanges.getChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
640
|
-
<li class="tsd-description">
|
|
641
|
-
<div class="tsd-comment tsd-typography"><p>Returns the changes that happened to the document
|
|
642
|
-
in the format that will be sent to MongoDB.</p>
|
|
643
|
-
</div>
|
|
644
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
645
|
-
<p>Inherited from Document.getChanges</p>
|
|
646
|
-
<ul>
|
|
647
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-151">node_modules/mongoose/types/document.d.ts:151</a></li></ul></aside></li></ul></section>
|
|
648
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="increment" class="tsd-anchor"></a>
|
|
649
|
-
<h3 class="tsd-anchor-link"><span>increment</span><a href="#increment" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
650
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
651
|
-
<li class="tsd-signature tsd-anchor-link" id="increment.increment-1">increment<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#increment.increment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
652
|
-
<li class="tsd-description">
|
|
653
|
-
<div class="tsd-comment tsd-typography"><p>Signal that we desire an increment of this documents version.</p>
|
|
654
|
-
</div>
|
|
655
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
656
|
-
<p>Inherited from Document.increment</p>
|
|
657
|
-
<ul>
|
|
658
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-157">node_modules/mongoose/types/document.d.ts:157</a></li></ul></aside></li></ul></section>
|
|
659
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="init" class="tsd-anchor"></a>
|
|
660
|
-
<h3 class="tsd-anchor-link"><span>init</span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
661
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
662
|
-
<li class="tsd-signature tsd-anchor-link" id="init.init-1">init<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#init.init-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
663
|
-
<li class="tsd-description">
|
|
664
|
-
<div class="tsd-comment tsd-typography"><p>Initializes the document without setters or marking anything modified.
|
|
665
|
-
Called internally after a document is returned from mongodb. Normally,
|
|
666
|
-
you do <strong>not</strong> need to call this function on your own.</p>
|
|
667
|
-
</div>
|
|
668
|
-
<div class="tsd-parameters">
|
|
669
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
670
|
-
<ul class="tsd-parameter-list">
|
|
671
|
-
<li>
|
|
672
|
-
<h5>obj: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
673
|
-
<li>
|
|
674
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
675
|
-
<li>
|
|
676
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
677
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
678
|
-
<p>Inherited from Document.init</p>
|
|
679
|
-
<ul>
|
|
680
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-164">node_modules/mongoose/types/document.d.ts:164</a></li></ul></aside></li></ul></section>
|
|
681
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="invalidate" class="tsd-anchor"></a>
|
|
682
|
-
<h3 class="tsd-anchor-link"><span>invalidate</span><a href="#invalidate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
683
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
684
|
-
<li class="tsd-signature tsd-anchor-link" id="invalidate.invalidate-1">invalidate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, errorMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, kind<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span><a href="#invalidate.invalidate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
685
|
-
<li class="tsd-description">
|
|
686
|
-
<div class="tsd-comment tsd-typography"><p>Marks a path as invalid, causing validation to fail.</p>
|
|
687
|
-
</div>
|
|
688
|
-
<div class="tsd-parameters">
|
|
689
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
690
|
-
<ul class="tsd-parameter-list">
|
|
691
|
-
<li>
|
|
692
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
693
|
-
<li>
|
|
694
|
-
<h5>errorMsg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span></h5></li>
|
|
695
|
-
<li>
|
|
696
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> value: <span class="tsd-signature-type">any</span></h5></li>
|
|
697
|
-
<li>
|
|
698
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> kind: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
699
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span></h4><aside class="tsd-sources">
|
|
700
|
-
<p>Inherited from Document.invalidate</p>
|
|
701
|
-
<ul>
|
|
702
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-167">node_modules/mongoose/types/document.d.ts:167</a></li></ul></aside></li></ul></section>
|
|
703
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isDirectModified" class="tsd-anchor"></a>
|
|
704
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Direct<wbr/>Modified</span><a href="#isDirectModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
705
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
706
|
-
<li class="tsd-signature tsd-anchor-link" id="isDirectModified.isDirectModified-1">is<wbr/>Direct<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isDirectModified.isDirectModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
707
|
-
<li class="tsd-description">
|
|
708
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if <code>path</code> was directly set and modified, else false.</p>
|
|
709
|
-
</div>
|
|
710
|
-
<div class="tsd-parameters">
|
|
711
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
712
|
-
<ul class="tsd-parameter-list">
|
|
713
|
-
<li>
|
|
714
|
-
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
715
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
716
|
-
<p>Inherited from Document.isDirectModified</p>
|
|
717
|
-
<ul>
|
|
718
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-170">node_modules/mongoose/types/document.d.ts:170</a></li></ul></aside></li></ul></section>
|
|
719
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isDirectSelected" class="tsd-anchor"></a>
|
|
720
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Direct<wbr/>Selected</span><a href="#isDirectSelected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
721
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
722
|
-
<li class="tsd-signature tsd-anchor-link" id="isDirectSelected.isDirectSelected-1">is<wbr/>Direct<wbr/>Selected<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isDirectSelected.isDirectSelected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
723
|
-
<li class="tsd-description">
|
|
724
|
-
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> was explicitly selected. If no projection, always returns true.</p>
|
|
725
|
-
</div>
|
|
726
|
-
<div class="tsd-parameters">
|
|
727
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
728
|
-
<ul class="tsd-parameter-list">
|
|
729
|
-
<li>
|
|
730
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
731
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
732
|
-
<p>Inherited from Document.isDirectSelected</p>
|
|
733
|
-
<ul>
|
|
734
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-173">node_modules/mongoose/types/document.d.ts:173</a></li></ul></aside></li></ul></section>
|
|
735
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isInit" class="tsd-anchor"></a>
|
|
736
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Init</span><a href="#isInit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
737
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
738
|
-
<li class="tsd-signature tsd-anchor-link" id="isInit.isInit-1">is<wbr/>Init<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isInit.isInit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
739
|
-
<li class="tsd-description">
|
|
740
|
-
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> is in the <code>init</code> state, that is, it was set by <code>Document#init()</code> and not modified since.</p>
|
|
741
|
-
</div>
|
|
742
|
-
<div class="tsd-parameters">
|
|
743
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
744
|
-
<ul class="tsd-parameter-list">
|
|
745
|
-
<li>
|
|
746
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
747
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
748
|
-
<p>Inherited from Document.isInit</p>
|
|
749
|
-
<ul>
|
|
750
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-176">node_modules/mongoose/types/document.d.ts:176</a></li></ul></aside></li></ul></section>
|
|
751
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isModified" class="tsd-anchor"></a>
|
|
752
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Modified</span><a href="#isModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
753
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
754
|
-
<li class="tsd-signature tsd-anchor-link" id="isModified.isModified-1">is<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isModified.isModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
755
|
-
<li class="tsd-description">
|
|
756
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if any of the given paths are modified, else false. If no arguments, returns <code>true</code> if any path
|
|
757
|
-
in this document is modified.</p>
|
|
758
|
-
</div>
|
|
759
|
-
<div class="tsd-parameters">
|
|
760
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
761
|
-
<ul class="tsd-parameter-list">
|
|
762
|
-
<li>
|
|
763
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
764
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
765
|
-
<p>Inherited from Document.isModified</p>
|
|
766
|
-
<ul>
|
|
767
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-182">node_modules/mongoose/types/document.d.ts:182</a></li></ul></aside></li></ul></section>
|
|
768
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isSelected" class="tsd-anchor"></a>
|
|
769
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Selected</span><a href="#isSelected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
770
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
771
|
-
<li class="tsd-signature tsd-anchor-link" id="isSelected.isSelected-1">is<wbr/>Selected<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isSelected.isSelected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
772
|
-
<li class="tsd-description">
|
|
773
|
-
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> was selected in the source query which initialized this document.</p>
|
|
774
|
-
</div>
|
|
775
|
-
<div class="tsd-parameters">
|
|
776
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
777
|
-
<ul class="tsd-parameter-list">
|
|
778
|
-
<li>
|
|
779
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
780
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
781
|
-
<p>Inherited from Document.isSelected</p>
|
|
782
|
-
<ul>
|
|
783
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-188">node_modules/mongoose/types/document.d.ts:188</a></li></ul></aside></li></ul></section>
|
|
784
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="markModified" class="tsd-anchor"></a>
|
|
785
|
-
<h3 class="tsd-anchor-link"><span>mark<wbr/>Modified</span><a href="#markModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
786
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
787
|
-
<li class="tsd-signature tsd-anchor-link" id="markModified.markModified-1">mark<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#markModified.markModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
788
|
-
<li class="tsd-description">
|
|
789
|
-
<div class="tsd-comment tsd-typography"><p>Marks the path as having pending changes to write to the db.</p>
|
|
790
|
-
</div>
|
|
791
|
-
<div class="tsd-parameters">
|
|
792
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
793
|
-
<ul class="tsd-parameter-list">
|
|
794
|
-
<li>
|
|
795
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
796
|
-
<li>
|
|
797
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> scope: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
798
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
799
|
-
<p>Inherited from Document.markModified</p>
|
|
800
|
-
<ul>
|
|
801
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-191">node_modules/mongoose/types/document.d.ts:191</a></li></ul></aside></li></ul></section>
|
|
802
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="modifiedPaths" class="tsd-anchor"></a>
|
|
803
|
-
<h3 class="tsd-anchor-link"><span>modified<wbr/>Paths</span><a href="#modifiedPaths" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
804
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
805
|
-
<li class="tsd-signature tsd-anchor-link" id="modifiedPaths.modifiedPaths-1">modified<wbr/>Paths<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>includeChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#modifiedPaths.modifiedPaths-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
806
|
-
<li class="tsd-description">
|
|
807
|
-
<div class="tsd-comment tsd-typography"><p>Returns the list of paths that have been modified.</p>
|
|
808
|
-
</div>
|
|
809
|
-
<div class="tsd-parameters">
|
|
810
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
811
|
-
<ul class="tsd-parameter-list">
|
|
812
|
-
<li>
|
|
813
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>includeChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
814
|
-
<ul class="tsd-parameters">
|
|
815
|
-
<li class="tsd-parameter">
|
|
816
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> include<wbr/>Children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
|
|
817
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
818
|
-
<p>Inherited from Document.modifiedPaths</p>
|
|
819
|
-
<ul>
|
|
820
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-194">node_modules/mongoose/types/document.d.ts:194</a></li></ul></aside></li></ul></section>
|
|
821
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="overwrite" class="tsd-anchor"></a>
|
|
822
|
-
<h3 class="tsd-anchor-link"><span>overwrite</span><a href="#overwrite" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
823
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
824
|
-
<li class="tsd-signature tsd-anchor-link" id="overwrite.overwrite-1">overwrite<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#overwrite.overwrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
825
|
-
<li class="tsd-description">
|
|
826
|
-
<div class="tsd-comment tsd-typography"><p>Overwrite all values in this document with the values of <code>obj</code>, except
|
|
827
|
-
for immutable properties. Behaves similarly to <code>set()</code>, except for it
|
|
828
|
-
unsets all properties that aren't in <code>obj</code>.</p>
|
|
829
|
-
</div>
|
|
830
|
-
<div class="tsd-parameters">
|
|
831
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
832
|
-
<ul class="tsd-parameter-list">
|
|
833
|
-
<li>
|
|
834
|
-
<h5>obj: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
835
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
836
|
-
<p>Inherited from Document.overwrite</p>
|
|
837
|
-
<ul>
|
|
838
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-201">node_modules/mongoose/types/document.d.ts:201</a></li></ul></aside></li></ul></section>
|
|
839
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="populate" class="tsd-anchor"></a>
|
|
840
|
-
<h3 class="tsd-anchor-link"><span>populate</span><a href="#populate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
841
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
842
|
-
<li class="tsd-signature tsd-anchor-link" id="populate.populate-1">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#populate.populate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
843
|
-
<li class="tsd-description">
|
|
844
|
-
<div class="tsd-comment tsd-typography"><p>Populates document references.</p>
|
|
845
|
-
</div>
|
|
846
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
847
|
-
<h4>Type Parameters</h4>
|
|
848
|
-
<ul class="tsd-type-parameters">
|
|
849
|
-
<li>
|
|
850
|
-
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
851
|
-
<div class="tsd-parameters">
|
|
852
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
853
|
-
<ul class="tsd-parameter-list">
|
|
854
|
-
<li>
|
|
855
|
-
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
856
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
857
|
-
<p>Inherited from Document.populate</p>
|
|
858
|
-
<ul>
|
|
859
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-210">node_modules/mongoose/types/document.d.ts:210</a></li></ul></aside></li>
|
|
860
|
-
<li class="tsd-signature tsd-anchor-link" id="populate.populate-2">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#populate.populate-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
861
|
-
<li class="tsd-description">
|
|
862
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
863
|
-
<h4>Type Parameters</h4>
|
|
864
|
-
<ul class="tsd-type-parameters">
|
|
865
|
-
<li>
|
|
866
|
-
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
867
|
-
<div class="tsd-parameters">
|
|
868
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
869
|
-
<ul class="tsd-parameter-list">
|
|
870
|
-
<li>
|
|
871
|
-
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
872
|
-
<li>
|
|
873
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
874
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
875
|
-
<p>Inherited from Document.populate</p>
|
|
876
|
-
<ul>
|
|
877
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-211">node_modules/mongoose/types/document.d.ts:211</a></li></ul></aside></li>
|
|
878
|
-
<li class="tsd-signature tsd-anchor-link" id="populate.populate-3">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span>, model<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, match<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#populate.populate-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
879
|
-
<li class="tsd-description">
|
|
880
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
881
|
-
<h4>Type Parameters</h4>
|
|
882
|
-
<ul class="tsd-type-parameters">
|
|
883
|
-
<li>
|
|
884
|
-
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
885
|
-
<div class="tsd-parameters">
|
|
886
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
887
|
-
<ul class="tsd-parameter-list">
|
|
888
|
-
<li>
|
|
889
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
890
|
-
<li>
|
|
891
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> select: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
892
|
-
<li>
|
|
893
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> model: <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
894
|
-
<li>
|
|
895
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> match: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
896
|
-
<li>
|
|
897
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">PopulateOptions</span></h5></li></ul></div>
|
|
898
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
899
|
-
<p>Inherited from Document.populate</p>
|
|
900
|
-
<ul>
|
|
901
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-212">node_modules/mongoose/types/document.d.ts:212</a></li></ul></aside></li>
|
|
902
|
-
<li class="tsd-signature tsd-anchor-link" id="populate.populate-4">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span>, model<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, match<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PopulateOptions</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#populate.populate-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
903
|
-
<li class="tsd-description">
|
|
904
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
905
|
-
<h4>Type Parameters</h4>
|
|
906
|
-
<ul class="tsd-type-parameters">
|
|
907
|
-
<li>
|
|
908
|
-
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
909
|
-
<div class="tsd-parameters">
|
|
910
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
911
|
-
<ul class="tsd-parameter-list">
|
|
912
|
-
<li>
|
|
913
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
914
|
-
<li>
|
|
915
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> select: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
916
|
-
<li>
|
|
917
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> model: <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
918
|
-
<li>
|
|
919
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> match: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
920
|
-
<li>
|
|
921
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">PopulateOptions</span></h5></li>
|
|
922
|
-
<li>
|
|
923
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
924
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
925
|
-
<p>Inherited from Document.populate</p>
|
|
926
|
-
<ul>
|
|
927
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-213">node_modules/mongoose/types/document.d.ts:213</a></li></ul></aside></li></ul></section>
|
|
928
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="populated" class="tsd-anchor"></a>
|
|
929
|
-
<h3 class="tsd-anchor-link"><span>populated</span><a href="#populated" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
930
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
931
|
-
<li class="tsd-signature tsd-anchor-link" id="populated.populated-1">populated<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#populated.populated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
932
|
-
<li class="tsd-description">
|
|
933
|
-
<div class="tsd-comment tsd-typography"><p>Gets _id(s) used during population of the given <code>path</code>. If the path was not populated, returns <code>undefined</code>.</p>
|
|
934
|
-
</div>
|
|
935
|
-
<div class="tsd-parameters">
|
|
936
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
937
|
-
<ul class="tsd-parameter-list">
|
|
938
|
-
<li>
|
|
939
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
940
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
941
|
-
<p>Inherited from Document.populated</p>
|
|
942
|
-
<ul>
|
|
943
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-216">node_modules/mongoose/types/document.d.ts:216</a></li></ul></aside></li></ul></section>
|
|
944
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="remove" class="tsd-anchor"></a>
|
|
945
|
-
<h3 class="tsd-anchor-link"><span>remove</span><a href="#remove" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
946
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
947
|
-
<li class="tsd-signature tsd-anchor-link" id="remove.remove-1">remove<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#remove.remove-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
948
|
-
<li class="tsd-description">
|
|
949
|
-
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
950
|
-
</div>
|
|
951
|
-
<div class="tsd-parameters">
|
|
952
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
953
|
-
<ul class="tsd-parameter-list">
|
|
954
|
-
<li>
|
|
955
|
-
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
956
|
-
<li>
|
|
957
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
958
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
959
|
-
<p>Inherited from Document.remove</p>
|
|
960
|
-
<ul>
|
|
961
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-219">node_modules/mongoose/types/document.d.ts:219</a></li></ul></aside></li>
|
|
962
|
-
<li class="tsd-signature tsd-anchor-link" id="remove.remove-2">remove<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#remove.remove-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
963
|
-
<li class="tsd-description">
|
|
964
|
-
<div class="tsd-parameters">
|
|
965
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
966
|
-
<ul class="tsd-parameter-list">
|
|
967
|
-
<li>
|
|
968
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
969
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
970
|
-
<p>Inherited from Document.remove</p>
|
|
971
|
-
<ul>
|
|
972
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-220">node_modules/mongoose/types/document.d.ts:220</a></li></ul></aside></li>
|
|
973
|
-
<li class="tsd-signature tsd-anchor-link" id="remove.remove-3">remove<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#remove.remove-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
974
|
-
<li class="tsd-description">
|
|
975
|
-
<div class="tsd-parameters">
|
|
976
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
977
|
-
<ul class="tsd-parameter-list">
|
|
978
|
-
<li>
|
|
979
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
980
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
981
|
-
<p>Inherited from Document.remove</p>
|
|
982
|
-
<ul>
|
|
983
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-221">node_modules/mongoose/types/document.d.ts:221</a></li></ul></aside></li></ul></section>
|
|
984
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="replaceOne" class="tsd-anchor"></a>
|
|
985
|
-
<h3 class="tsd-anchor-link"><span>replace<wbr/>One</span><a href="#replaceOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
986
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
987
|
-
<li class="tsd-signature tsd-anchor-link" id="replaceOne.replaceOne-1">replace<wbr/>One<span class="tsd-signature-symbol">(</span>replacement<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#replaceOne.replaceOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
988
|
-
<li class="tsd-description">
|
|
989
|
-
<div class="tsd-comment tsd-typography"><p>Sends a replaceOne command with this document <code>_id</code> as the query selector.</p>
|
|
990
|
-
</div>
|
|
991
|
-
<div class="tsd-parameters">
|
|
992
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
993
|
-
<ul class="tsd-parameter-list">
|
|
994
|
-
<li>
|
|
995
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> replacement: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
996
|
-
<li>
|
|
997
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
998
|
-
<li>
|
|
999
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1000
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1001
|
-
<p>Inherited from Document.replaceOne</p>
|
|
1002
|
-
<ul>
|
|
1003
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-224">node_modules/mongoose/types/document.d.ts:224</a></li></ul></aside></li></ul></section>
|
|
1004
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="save" class="tsd-anchor"></a>
|
|
1005
|
-
<h3 class="tsd-anchor-link"><span>save</span><a href="#save" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1006
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1007
|
-
<li class="tsd-signature tsd-anchor-link" id="save.save-1">save<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SaveOptions</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#save.save-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1008
|
-
<li class="tsd-description">
|
|
1009
|
-
<div class="tsd-comment tsd-typography"><p>Saves this document by inserting a new document into the database if <a href="/docs/api/document.html#document_Document-isNew">document.isNew</a> is <code>true</code>, or sends an <a href="/docs/api/document.html#document_Document-updateOne">updateOne</a> operation with just the modified paths if <code>isNew</code> is <code>false</code>.</p>
|
|
1010
|
-
</div>
|
|
1011
|
-
<div class="tsd-parameters">
|
|
1012
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1013
|
-
<ul class="tsd-parameter-list">
|
|
1014
|
-
<li>
|
|
1015
|
-
<h5>options: <span class="tsd-signature-type">SaveOptions</span></h5></li>
|
|
1016
|
-
<li>
|
|
1017
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1018
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1019
|
-
<p>Inherited from Document.save</p>
|
|
1020
|
-
<ul>
|
|
1021
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-227">node_modules/mongoose/types/document.d.ts:227</a></li></ul></aside></li>
|
|
1022
|
-
<li class="tsd-signature tsd-anchor-link" id="save.save-2">save<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#save.save-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1023
|
-
<li class="tsd-description">
|
|
1024
|
-
<div class="tsd-parameters">
|
|
1025
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1026
|
-
<ul class="tsd-parameter-list">
|
|
1027
|
-
<li>
|
|
1028
|
-
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1029
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1030
|
-
<p>Inherited from Document.save</p>
|
|
1031
|
-
<ul>
|
|
1032
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-228">node_modules/mongoose/types/document.d.ts:228</a></li></ul></aside></li>
|
|
1033
|
-
<li class="tsd-signature tsd-anchor-link" id="save.save-3">save<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SaveOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#save.save-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1034
|
-
<li class="tsd-description">
|
|
1035
|
-
<div class="tsd-parameters">
|
|
1036
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1037
|
-
<ul class="tsd-parameter-list">
|
|
1038
|
-
<li>
|
|
1039
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SaveOptions</span></h5></li></ul></div>
|
|
1040
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1041
|
-
<p>Inherited from Document.save</p>
|
|
1042
|
-
<ul>
|
|
1043
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-229">node_modules/mongoose/types/document.d.ts:229</a></li></ul></aside></li></ul></section>
|
|
1044
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="set" class="tsd-anchor"></a>
|
|
1045
|
-
<h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1046
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1047
|
-
<li class="tsd-signature tsd-anchor-link" id="set.set-1">set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1048
|
-
<li class="tsd-description">
|
|
1049
|
-
<div class="tsd-comment tsd-typography"><p>Sets the value of a path, or many paths.</p>
|
|
1050
|
-
</div>
|
|
1051
|
-
<div class="tsd-parameters">
|
|
1052
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1053
|
-
<ul class="tsd-parameter-list">
|
|
1054
|
-
<li>
|
|
1055
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
1056
|
-
<li>
|
|
1057
|
-
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
1058
|
-
<li>
|
|
1059
|
-
<h5>type: <span class="tsd-signature-type">any</span></h5></li>
|
|
1060
|
-
<li>
|
|
1061
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1062
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1063
|
-
<p>Inherited from Document.set</p>
|
|
1064
|
-
<ul>
|
|
1065
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-235">node_modules/mongoose/types/document.d.ts:235</a></li></ul></aside></li>
|
|
1066
|
-
<li class="tsd-signature tsd-anchor-link" id="set.set-2">set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1067
|
-
<li class="tsd-description">
|
|
1068
|
-
<div class="tsd-parameters">
|
|
1069
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1070
|
-
<ul class="tsd-parameter-list">
|
|
1071
|
-
<li>
|
|
1072
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
1073
|
-
<li>
|
|
1074
|
-
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
1075
|
-
<li>
|
|
1076
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1077
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1078
|
-
<p>Inherited from Document.set</p>
|
|
1079
|
-
<ul>
|
|
1080
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-236">node_modules/mongoose/types/document.d.ts:236</a></li></ul></aside></li>
|
|
1081
|
-
<li class="tsd-signature tsd-anchor-link" id="set.set-3">set<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1082
|
-
<li class="tsd-description">
|
|
1083
|
-
<div class="tsd-parameters">
|
|
1084
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1085
|
-
<ul class="tsd-parameter-list">
|
|
1086
|
-
<li>
|
|
1087
|
-
<h5>value: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1088
|
-
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1089
|
-
<p>Inherited from Document.set</p>
|
|
1090
|
-
<ul>
|
|
1091
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-237">node_modules/mongoose/types/document.d.ts:237</a></li></ul></aside></li></ul></section>
|
|
1092
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a>
|
|
1093
|
-
<h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1094
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1095
|
-
<li class="tsd-signature tsd-anchor-link" id="toJSON.toJSON-1">toJSON<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FlattenMaps</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1096
|
-
<li class="tsd-description">
|
|
1097
|
-
<div class="tsd-comment tsd-typography"><p>The return value of this method is used in calls to JSON.stringify(doc).</p>
|
|
1098
|
-
</div>
|
|
1099
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
1100
|
-
<h4>Type Parameters</h4>
|
|
1101
|
-
<ul class="tsd-type-parameters">
|
|
1102
|
-
<li>
|
|
1103
|
-
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1104
|
-
<div class="tsd-parameters">
|
|
1105
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1106
|
-
<ul class="tsd-parameter-list">
|
|
1107
|
-
<li>
|
|
1108
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5></li></ul></div>
|
|
1109
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FlattenMaps</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1110
|
-
<p>Inherited from Document.toJSON</p>
|
|
1111
|
-
<ul>
|
|
1112
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-240">node_modules/mongoose/types/document.d.ts:240</a></li></ul></aside></li>
|
|
1113
|
-
<li class="tsd-signature tsd-anchor-link" id="toJSON.toJSON-2">toJSON<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><a href="#toJSON.toJSON-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1114
|
-
<li class="tsd-description">
|
|
1115
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
1116
|
-
<h4>Type Parameters</h4>
|
|
1117
|
-
<ul class="tsd-type-parameters">
|
|
1118
|
-
<li>
|
|
1119
|
-
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1120
|
-
<div class="tsd-parameters">
|
|
1121
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1122
|
-
<ul class="tsd-parameter-list">
|
|
1123
|
-
<li>
|
|
1124
|
-
<h5>options: <span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5></li></ul></div>
|
|
1125
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><aside class="tsd-sources">
|
|
1126
|
-
<p>Inherited from Document.toJSON</p>
|
|
1127
|
-
<ul>
|
|
1128
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-241">node_modules/mongoose/types/document.d.ts:241</a></li></ul></aside></li></ul></section>
|
|
1129
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="toObject" class="tsd-anchor"></a>
|
|
1130
|
-
<h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toObject" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1131
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1132
|
-
<li class="tsd-signature tsd-anchor-link" id="toObject.toObject-1">to<wbr/>Object<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Require_id</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#toObject.toObject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1133
|
-
<li class="tsd-description">
|
|
1134
|
-
<div class="tsd-comment tsd-typography"><p>Converts this document into a plain-old JavaScript object (<a href="https://masteringjs.io/tutorials/fundamentals/pojo">POJO</a>).</p>
|
|
1135
|
-
</div>
|
|
1136
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
1137
|
-
<h4>Type Parameters</h4>
|
|
1138
|
-
<ul class="tsd-type-parameters">
|
|
1139
|
-
<li>
|
|
1140
|
-
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1141
|
-
<div class="tsd-parameters">
|
|
1142
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1143
|
-
<ul class="tsd-parameter-list">
|
|
1144
|
-
<li>
|
|
1145
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ToObjectOptions</span></h5></li></ul></div>
|
|
1146
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Require_id</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1147
|
-
<p>Inherited from Document.toObject</p>
|
|
1148
|
-
<ul>
|
|
1149
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-244">node_modules/mongoose/types/document.d.ts:244</a></li></ul></aside></li></ul></section>
|
|
1150
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="unmarkModified" class="tsd-anchor"></a>
|
|
1151
|
-
<h3 class="tsd-anchor-link"><span>unmark<wbr/>Modified</span><a href="#unmarkModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1152
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1153
|
-
<li class="tsd-signature tsd-anchor-link" id="unmarkModified.unmarkModified-1">unmark<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmarkModified.unmarkModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1154
|
-
<li class="tsd-description">
|
|
1155
|
-
<div class="tsd-comment tsd-typography"><p>Clears the modified state on the specified path.</p>
|
|
1156
|
-
</div>
|
|
1157
|
-
<div class="tsd-parameters">
|
|
1158
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1159
|
-
<ul class="tsd-parameter-list">
|
|
1160
|
-
<li>
|
|
1161
|
-
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
1162
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1163
|
-
<p>Inherited from Document.unmarkModified</p>
|
|
1164
|
-
<ul>
|
|
1165
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-247">node_modules/mongoose/types/document.d.ts:247</a></li></ul></aside></li></ul></section>
|
|
1166
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="update" class="tsd-anchor"></a>
|
|
1167
|
-
<h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1168
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1169
|
-
<li class="tsd-signature tsd-anchor-link" id="update.update-1">update<span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#update.update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1170
|
-
<li class="tsd-description">
|
|
1171
|
-
<div class="tsd-comment tsd-typography"><p>Sends an update command with this document <code>_id</code> as the query selector.</p>
|
|
1172
|
-
</div>
|
|
1173
|
-
<div class="tsd-parameters">
|
|
1174
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1175
|
-
<ul class="tsd-parameter-list">
|
|
1176
|
-
<li>
|
|
1177
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> update: <span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li>
|
|
1178
|
-
<li>
|
|
1179
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
1180
|
-
<li>
|
|
1181
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1182
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1183
|
-
<p>Inherited from Document.update</p>
|
|
1184
|
-
<ul>
|
|
1185
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-250">node_modules/mongoose/types/document.d.ts:250</a></li></ul></aside></li></ul></section>
|
|
1186
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="updateOne" class="tsd-anchor"></a>
|
|
1187
|
-
<h3 class="tsd-anchor-link"><span>update<wbr/>One</span><a href="#updateOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1188
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1189
|
-
<li class="tsd-signature tsd-anchor-link" id="updateOne.updateOne-1">update<wbr/>One<span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#updateOne.updateOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1190
|
-
<li class="tsd-description">
|
|
1191
|
-
<div class="tsd-comment tsd-typography"><p>Sends an updateOne command with this document <code>_id</code> as the query selector.</p>
|
|
1192
|
-
</div>
|
|
1193
|
-
<div class="tsd-parameters">
|
|
1194
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1195
|
-
<ul class="tsd-parameter-list">
|
|
1196
|
-
<li>
|
|
1197
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> update: <span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li>
|
|
1198
|
-
<li>
|
|
1199
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
1200
|
-
<li>
|
|
1201
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1202
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1203
|
-
<p>Inherited from Document.updateOne</p>
|
|
1204
|
-
<ul>
|
|
1205
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-253">node_modules/mongoose/types/document.d.ts:253</a></li></ul></aside></li></ul></section>
|
|
1206
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="validate" class="tsd-anchor"></a>
|
|
1207
|
-
<h3 class="tsd-anchor-link"><span>validate</span><a href="#validate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1208
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1209
|
-
<li class="tsd-signature tsd-anchor-link" id="validate.validate-1">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1210
|
-
<li class="tsd-description">
|
|
1211
|
-
<div class="tsd-comment tsd-typography"><p>Executes registered validation rules for this document.</p>
|
|
1212
|
-
</div>
|
|
1213
|
-
<div class="tsd-parameters">
|
|
1214
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1215
|
-
<ul class="tsd-parameter-list">
|
|
1216
|
-
<li>
|
|
1217
|
-
<h5>pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1218
|
-
<li>
|
|
1219
|
-
<h5>options: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
1220
|
-
<li>
|
|
1221
|
-
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1222
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1223
|
-
<p>Inherited from Document.validate</p>
|
|
1224
|
-
<ul>
|
|
1225
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-256">node_modules/mongoose/types/document.d.ts:256</a></li></ul></aside></li>
|
|
1226
|
-
<li class="tsd-signature tsd-anchor-link" id="validate.validate-2">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathsToValidate</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1227
|
-
<li class="tsd-description">
|
|
1228
|
-
<div class="tsd-parameters">
|
|
1229
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1230
|
-
<ul class="tsd-parameter-list">
|
|
1231
|
-
<li>
|
|
1232
|
-
<h5>pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1233
|
-
<li>
|
|
1234
|
-
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1235
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1236
|
-
<p>Inherited from Document.validate</p>
|
|
1237
|
-
<ul>
|
|
1238
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-257">node_modules/mongoose/types/document.d.ts:257</a></li></ul></aside></li>
|
|
1239
|
-
<li class="tsd-signature tsd-anchor-link" id="validate.validate-3">validate<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1240
|
-
<li class="tsd-description">
|
|
1241
|
-
<div class="tsd-parameters">
|
|
1242
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1243
|
-
<ul class="tsd-parameter-list">
|
|
1244
|
-
<li>
|
|
1245
|
-
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1246
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1247
|
-
<p>Inherited from Document.validate</p>
|
|
1248
|
-
<ul>
|
|
1249
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-258">node_modules/mongoose/types/document.d.ts:258</a></li></ul></aside></li>
|
|
1250
|
-
<li class="tsd-signature tsd-anchor-link" id="validate.validate-4">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validate.validate-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1251
|
-
<li class="tsd-description">
|
|
1252
|
-
<div class="tsd-parameters">
|
|
1253
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1254
|
-
<ul class="tsd-parameter-list">
|
|
1255
|
-
<li>
|
|
1256
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1257
|
-
<li>
|
|
1258
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
1259
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1260
|
-
<p>Inherited from Document.validate</p>
|
|
1261
|
-
<ul>
|
|
1262
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-259">node_modules/mongoose/types/document.d.ts:259</a></li></ul></aside></li>
|
|
1263
|
-
<li class="tsd-signature tsd-anchor-link" id="validate.validate-5">validate<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validate.validate-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1264
|
-
<li class="tsd-description">
|
|
1265
|
-
<div class="tsd-parameters">
|
|
1266
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1267
|
-
<ul class="tsd-parameter-list">
|
|
1268
|
-
<li>
|
|
1269
|
-
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
1270
|
-
<ul class="tsd-parameters">
|
|
1271
|
-
<li class="tsd-parameter">
|
|
1272
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> paths<wbr/>To<wbr/>Skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span></h5></li></ul></li></ul></div>
|
|
1273
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1274
|
-
<p>Inherited from Document.validate</p>
|
|
1275
|
-
<ul>
|
|
1276
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-260">node_modules/mongoose/types/document.d.ts:260</a></li></ul></aside></li></ul></section>
|
|
1277
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="validateSync" class="tsd-anchor"></a>
|
|
1278
|
-
<h3 class="tsd-anchor-link"><span>validate<wbr/>Sync</span><a href="#validateSync" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1279
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1280
|
-
<li class="tsd-signature tsd-anchor-link" id="validateSync.validateSync-1">validate<wbr/>Sync<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span> </span>[k: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span><a href="#validateSync.validateSync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1281
|
-
<li class="tsd-description">
|
|
1282
|
-
<div class="tsd-comment tsd-typography"><p>Executes registered validation rules (skipping asynchronous validators) for this document.</p>
|
|
1283
|
-
</div>
|
|
1284
|
-
<div class="tsd-parameters">
|
|
1285
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1286
|
-
<ul class="tsd-parameter-list">
|
|
1287
|
-
<li>
|
|
1288
|
-
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span> </span>[k: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
1289
|
-
<ul class="tsd-parameters">
|
|
1290
|
-
<li class="tsd-parameter-index-signature">
|
|
1291
|
-
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li>
|
|
1292
|
-
<li class="tsd-parameter">
|
|
1293
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> paths<wbr/>To<wbr/>Skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span></h5></li></ul></li></ul></div>
|
|
1294
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span></h4><aside class="tsd-sources">
|
|
1295
|
-
<p>Inherited from Document.validateSync</p>
|
|
1296
|
-
<ul>
|
|
1297
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-263">node_modules/mongoose/types/document.d.ts:263</a></li></ul></aside></li>
|
|
1298
|
-
<li class="tsd-signature tsd-anchor-link" id="validateSync.validateSync-2">validate<wbr/>Sync<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span><a href="#validateSync.validateSync-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1299
|
-
<li class="tsd-description">
|
|
1300
|
-
<div class="tsd-parameters">
|
|
1301
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1302
|
-
<ul class="tsd-parameter-list">
|
|
1303
|
-
<li>
|
|
1304
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1305
|
-
<li>
|
|
1306
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
1307
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span></h4><aside class="tsd-sources">
|
|
1308
|
-
<p>Inherited from Document.validateSync</p>
|
|
1309
|
-
<ul>
|
|
1310
|
-
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-264">node_modules/mongoose/types/document.d.ts:264</a></li></ul></aside></li></ul></section></section></div>
|
|
1311
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
1312
|
-
<div class="tsd-navigation settings">
|
|
1313
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1314
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
1315
|
-
<div class="tsd-accordion-details">
|
|
1316
|
-
<div class="tsd-filter-visibility">
|
|
1317
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1318
|
-
<ul id="tsd-filter-options">
|
|
1319
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
1320
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
1321
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
1322
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
1323
|
-
<div class="tsd-theme-toggle">
|
|
1324
|
-
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1325
|
-
<nav class="tsd-navigation primary">
|
|
1326
|
-
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
1327
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
1328
|
-
<div class="tsd-accordion-details">
|
|
1329
|
-
<ul>
|
|
1330
|
-
<li><a href="../modules.html">@bprotsyk/aso-<wbr/>core</a>
|
|
1331
|
-
<ul>
|
|
1332
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASOConfigFetch.html">ASOConfig<wbr/>Fetch</a></li>
|
|
1333
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v0.html">ASO_<wbr/>v0</a></li>
|
|
1334
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v1.html">ASO_<wbr/>v1</a></li>
|
|
1335
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v2.html">ASO_<wbr/>v2</a></li>
|
|
1336
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v3.html">ASO_<wbr/>v3</a></li>
|
|
1337
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v4.html">ASO_<wbr/>v4</a></li>
|
|
1338
|
-
<li class="tsd-kind-namespace"><a href="../modules/ASO_v5.html">ASO_<wbr/>v5</a></li></ul></li></ul></div></details></nav>
|
|
1339
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
1340
|
-
<ul>
|
|
1341
|
-
<li class="current tsd-kind-interface"><a href="IPanelUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>IPanel<wbr/>User</span></a>
|
|
1342
|
-
<ul>
|
|
1343
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_locals" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$locals</a></li>
|
|
1344
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_op" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$op</a></li>
|
|
1345
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_where" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$where</a></li>
|
|
1346
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#__v" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>__v?</a></li>
|
|
1347
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_id" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>_id?</a></li>
|
|
1348
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#accessScopes" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>access<wbr/>Scopes</a></li>
|
|
1349
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#baseModelName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>base<wbr/>Model<wbr/>Name?</a></li>
|
|
1350
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#collection" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>collection</a></li>
|
|
1351
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#db" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>db</a></li>
|
|
1352
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#errors" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>errors?</a></li>
|
|
1353
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>id?</a></li>
|
|
1354
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isNew" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>is<wbr/>New</a></li>
|
|
1355
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#passwordHash" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>password<wbr/>Hash</a></li>
|
|
1356
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#schema" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>schema</a></li>
|
|
1357
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>username</a></li>
|
|
1358
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_assertPopulated" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$assert<wbr/>Populated</a></li>
|
|
1359
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_clone" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$clone</a></li>
|
|
1360
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_getAllSubdocs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$get<wbr/>All<wbr/>Subdocs</a></li>
|
|
1361
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_getPopulatedDocs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$get<wbr/>Populated<wbr/>Docs</a></li>
|
|
1362
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_ignore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$ignore</a></li>
|
|
1363
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_inc" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$inc</a></li>
|
|
1364
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isDefault" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Default</a></li>
|
|
1365
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isDeleted" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Deleted</a></li>
|
|
1366
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isEmpty" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Empty</a></li>
|
|
1367
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isValid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Valid</a></li>
|
|
1368
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_markValid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$mark<wbr/>Valid</a></li>
|
|
1369
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_model" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$model</a></li>
|
|
1370
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_parent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$parent</a></li>
|
|
1371
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_session" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$session</a></li>
|
|
1372
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_set" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$set</a></li>
|
|
1373
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#delete" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete</a></li>
|
|
1374
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#deleteOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>One</a></li>
|
|
1375
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#depopulate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>depopulate</a></li>
|
|
1376
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#directModifiedPaths" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>direct<wbr/>Modified<wbr/>Paths</a></li>
|
|
1377
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#equals" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>equals</a></li>
|
|
1378
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#get" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get</a></li>
|
|
1379
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#getChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Changes</a></li>
|
|
1380
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#increment" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>increment</a></li>
|
|
1381
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#init" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>init</a></li>
|
|
1382
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#invalidate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>invalidate</a></li>
|
|
1383
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isDirectModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Direct<wbr/>Modified</a></li>
|
|
1384
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isDirectSelected" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Direct<wbr/>Selected</a></li>
|
|
1385
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isInit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Init</a></li>
|
|
1386
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Modified</a></li>
|
|
1387
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isSelected" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Selected</a></li>
|
|
1388
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#markModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>mark<wbr/>Modified</a></li>
|
|
1389
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#modifiedPaths" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>modified<wbr/>Paths</a></li>
|
|
1390
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#overwrite" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>overwrite</a></li>
|
|
1391
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#populate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>populate</a></li>
|
|
1392
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#populated" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>populated</a></li>
|
|
1393
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#remove" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove</a></li>
|
|
1394
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#replaceOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>replace<wbr/>One</a></li>
|
|
1395
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#save" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save</a></li>
|
|
1396
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set</a></li>
|
|
1397
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#toJSON" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>toJSON</a></li>
|
|
1398
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#toObject" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>Object</a></li>
|
|
1399
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#unmarkModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>unmark<wbr/>Modified</a></li>
|
|
1400
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#update" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update</a></li>
|
|
1401
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#updateOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>One</a></li>
|
|
1402
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#validate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate</a></li>
|
|
1403
|
-
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#validateSync" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Sync</a></li></ul></li></ul></nav></div></div>
|
|
1404
|
-
<div class="container tsd-generator">
|
|
1405
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPanelUser | @bprotsyk/aso-core</title><meta name="description" content="Documentation for @bprotsyk/aso-core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bprotsyk/aso-core</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-8 col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">@bprotsyk/aso-core</a></li>
|
|
16
|
+
<li><a href="IPanelUser.html">IPanelUser</a></li></ul>
|
|
17
|
+
<h1>Interface IPanelUser</h1></div>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
19
|
+
<h4>Hierarchy</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li><span class="tsd-signature-type">Document</span>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li><span class="target">IPanelUser</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-20">src/panel/user.ts:20</a></li></ul></aside>
|
|
26
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
+
<section class="tsd-panel tsd-index-panel">
|
|
28
|
+
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
29
|
+
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<section class="tsd-index-section">
|
|
32
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
|
33
|
+
<div class="tsd-index-list"><a href="IPanelUser.html#_locals" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>$locals</span></a>
|
|
34
|
+
<a href="IPanelUser.html#_op" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>$op</span></a>
|
|
35
|
+
<a href="IPanelUser.html#_where" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>$where</span></a>
|
|
36
|
+
<a href="IPanelUser.html#__v" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>__v?</span></a>
|
|
37
|
+
<a href="IPanelUser.html#_id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_id?</span></a>
|
|
38
|
+
<a href="IPanelUser.html#accessScopes" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>access<wbr/>Scopes</span></a>
|
|
39
|
+
<a href="IPanelUser.html#baseModelName" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>base<wbr/>Model<wbr/>Name?</span></a>
|
|
40
|
+
<a href="IPanelUser.html#collection" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>collection</span></a>
|
|
41
|
+
<a href="IPanelUser.html#db" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>db</span></a>
|
|
42
|
+
<a href="IPanelUser.html#errors" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>errors?</span></a>
|
|
43
|
+
<a href="IPanelUser.html#id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>id?</span></a>
|
|
44
|
+
<a href="IPanelUser.html#isNew" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>is<wbr/>New</span></a>
|
|
45
|
+
<a href="IPanelUser.html#passwordHash" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>password<wbr/>Hash</span></a>
|
|
46
|
+
<a href="IPanelUser.html#schema" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>schema</span></a>
|
|
47
|
+
<a href="IPanelUser.html#username" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>username</span></a>
|
|
48
|
+
</div></section>
|
|
49
|
+
<section class="tsd-index-section">
|
|
50
|
+
<h3 class="tsd-index-heading">Methods</h3>
|
|
51
|
+
<div class="tsd-index-list"><a href="IPanelUser.html#_assertPopulated" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>$assert<wbr/>Populated</span></a>
|
|
52
|
+
<a href="IPanelUser.html#_clone" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$clone</span></a>
|
|
53
|
+
<a href="IPanelUser.html#_getAllSubdocs" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$get<wbr/>All<wbr/>Subdocs</span></a>
|
|
54
|
+
<a href="IPanelUser.html#_getPopulatedDocs" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$get<wbr/>Populated<wbr/>Docs</span></a>
|
|
55
|
+
<a href="IPanelUser.html#_ignore" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$ignore</span></a>
|
|
56
|
+
<a href="IPanelUser.html#_inc" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$inc</span></a>
|
|
57
|
+
<a href="IPanelUser.html#_isDefault" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Default</span></a>
|
|
58
|
+
<a href="IPanelUser.html#_isDeleted" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Deleted</span></a>
|
|
59
|
+
<a href="IPanelUser.html#_isEmpty" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Empty</span></a>
|
|
60
|
+
<a href="IPanelUser.html#_isValid" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$is<wbr/>Valid</span></a>
|
|
61
|
+
<a href="IPanelUser.html#_markValid" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$mark<wbr/>Valid</span></a>
|
|
62
|
+
<a href="IPanelUser.html#_model" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$model</span></a>
|
|
63
|
+
<a href="IPanelUser.html#_parent" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$parent</span></a>
|
|
64
|
+
<a href="IPanelUser.html#_session" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$session</span></a>
|
|
65
|
+
<a href="IPanelUser.html#_set" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>$set</span></a>
|
|
66
|
+
<a href="IPanelUser.html#delete" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete</span></a>
|
|
67
|
+
<a href="IPanelUser.html#deleteOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>One</span></a>
|
|
68
|
+
<a href="IPanelUser.html#depopulate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>depopulate</span></a>
|
|
69
|
+
<a href="IPanelUser.html#directModifiedPaths" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>direct<wbr/>Modified<wbr/>Paths</span></a>
|
|
70
|
+
<a href="IPanelUser.html#equals" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>equals</span></a>
|
|
71
|
+
<a href="IPanelUser.html#get" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get</span></a>
|
|
72
|
+
<a href="IPanelUser.html#getChanges" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Changes</span></a>
|
|
73
|
+
<a href="IPanelUser.html#increment" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>increment</span></a>
|
|
74
|
+
<a href="IPanelUser.html#init" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>init</span></a>
|
|
75
|
+
<a href="IPanelUser.html#invalidate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>invalidate</span></a>
|
|
76
|
+
<a href="IPanelUser.html#isDirectModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Direct<wbr/>Modified</span></a>
|
|
77
|
+
<a href="IPanelUser.html#isDirectSelected" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Direct<wbr/>Selected</span></a>
|
|
78
|
+
<a href="IPanelUser.html#isInit" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Init</span></a>
|
|
79
|
+
<a href="IPanelUser.html#isModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Modified</span></a>
|
|
80
|
+
<a href="IPanelUser.html#isSelected" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Selected</span></a>
|
|
81
|
+
<a href="IPanelUser.html#markModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>mark<wbr/>Modified</span></a>
|
|
82
|
+
<a href="IPanelUser.html#modifiedPaths" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>modified<wbr/>Paths</span></a>
|
|
83
|
+
<a href="IPanelUser.html#overwrite" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>overwrite</span></a>
|
|
84
|
+
<a href="IPanelUser.html#populate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>populate</span></a>
|
|
85
|
+
<a href="IPanelUser.html#populated" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>populated</span></a>
|
|
86
|
+
<a href="IPanelUser.html#remove" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove</span></a>
|
|
87
|
+
<a href="IPanelUser.html#replaceOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>replace<wbr/>One</span></a>
|
|
88
|
+
<a href="IPanelUser.html#save" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save</span></a>
|
|
89
|
+
<a href="IPanelUser.html#set" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set</span></a>
|
|
90
|
+
<a href="IPanelUser.html#toJSON" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>toJSON</span></a>
|
|
91
|
+
<a href="IPanelUser.html#toObject" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>Object</span></a>
|
|
92
|
+
<a href="IPanelUser.html#unmarkModified" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unmark<wbr/>Modified</span></a>
|
|
93
|
+
<a href="IPanelUser.html#update" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update</span></a>
|
|
94
|
+
<a href="IPanelUser.html#updateOne" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>One</span></a>
|
|
95
|
+
<a href="IPanelUser.html#validate" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate</span></a>
|
|
96
|
+
<a href="IPanelUser.html#validateSync" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Sync</span></a>
|
|
97
|
+
</div></section></div></details></section></section>
|
|
98
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
99
|
+
<h2>Properties</h2>
|
|
100
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_locals" class="tsd-anchor"></a>
|
|
101
|
+
<h3 class="tsd-anchor-link"><span>$locals</span><a href="#_locals" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
102
|
+
<div class="tsd-signature">$locals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div>
|
|
103
|
+
<div class="tsd-comment tsd-typography"><p>Empty object that you can use for storing properties on the document. This
|
|
104
|
+
is handy for passing data to middleware without conflicting with Mongoose
|
|
105
|
+
internals.</p>
|
|
106
|
+
</div><aside class="tsd-sources">
|
|
107
|
+
<p>Inherited from Document.$locals</p>
|
|
108
|
+
<ul>
|
|
109
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-71">node_modules/mongoose/types/document.d.ts:71</a></li></ul></aside></section>
|
|
110
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_op" class="tsd-anchor"></a>
|
|
111
|
+
<h3 class="tsd-anchor-link"><span>$op</span><a href="#_op" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
112
|
+
<div class="tsd-signature">$op<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"remove"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"save"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"validate"</span></div>
|
|
113
|
+
<div class="tsd-comment tsd-typography"><p>A string containing the current operation that Mongoose is executing
|
|
114
|
+
on this document. Can be <code>null</code>, <code>'save'</code>, <code>'validate'</code>, or <code>'remove'</code>.</p>
|
|
115
|
+
</div><aside class="tsd-sources">
|
|
116
|
+
<p>Inherited from Document.$op</p>
|
|
117
|
+
<ul>
|
|
118
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-83">node_modules/mongoose/types/document.d.ts:83</a></li></ul></aside></section>
|
|
119
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_where" class="tsd-anchor"></a>
|
|
120
|
+
<h3 class="tsd-anchor-link"><span>$where</span><a href="#_where" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
121
|
+
<div class="tsd-signature">$where<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div>
|
|
122
|
+
<div class="tsd-comment tsd-typography"><p>Set this property to add additional query filters when Mongoose saves this document and <code>isNew</code> is false.</p>
|
|
123
|
+
</div><aside class="tsd-sources">
|
|
124
|
+
<p>Inherited from Document.$where</p>
|
|
125
|
+
<ul>
|
|
126
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-98">node_modules/mongoose/types/document.d.ts:98</a></li></ul></aside></section>
|
|
127
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="__v" class="tsd-anchor"></a>
|
|
128
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>__v</span><a href="#__v" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
129
|
+
<div class="tsd-signature">__v<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
130
|
+
<div class="tsd-comment tsd-typography"><p>This documents __v.</p>
|
|
131
|
+
</div><aside class="tsd-sources">
|
|
132
|
+
<p>Inherited from Document.__v</p>
|
|
133
|
+
<ul>
|
|
134
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-26">node_modules/mongoose/types/document.d.ts:26</a></li></ul></aside></section>
|
|
135
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_id" class="tsd-anchor"></a>
|
|
136
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>_id</span><a href="#_id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
137
|
+
<div class="tsd-signature">_id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
138
|
+
<div class="tsd-comment tsd-typography"><p>This documents _id.</p>
|
|
139
|
+
</div><aside class="tsd-sources">
|
|
140
|
+
<p>Inherited from Document._id</p>
|
|
141
|
+
<ul>
|
|
142
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-23">node_modules/mongoose/types/document.d.ts:23</a></li></ul></aside></section>
|
|
143
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="accessScopes" class="tsd-anchor"></a>
|
|
144
|
+
<h3 class="tsd-anchor-link"><span>access<wbr/>Scopes</span><a href="#accessScopes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
145
|
+
<div class="tsd-signature">access<wbr/>Scopes<span class="tsd-signature-symbol">:</span> <a href="../enums/PanelUserAccessScope.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PanelUserAccessScope</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
146
|
+
<ul>
|
|
147
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-23">src/panel/user.ts:23</a></li></ul></aside></section>
|
|
148
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="baseModelName" class="tsd-anchor"></a>
|
|
149
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Model<wbr/>Name</span><a href="#baseModelName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
150
|
+
<div class="tsd-signature">base<wbr/>Model<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
151
|
+
<div class="tsd-comment tsd-typography"><p>If this is a discriminator model, <code>baseModelName</code> is the name of the base model.</p>
|
|
152
|
+
</div><aside class="tsd-sources">
|
|
153
|
+
<p>Inherited from Document.baseModelName</p>
|
|
154
|
+
<ul>
|
|
155
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-101">node_modules/mongoose/types/document.d.ts:101</a></li></ul></aside></section>
|
|
156
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="collection" class="tsd-anchor"></a>
|
|
157
|
+
<h3 class="tsd-anchor-link"><span>collection</span><a href="#collection" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
158
|
+
<div class="tsd-signature">collection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Collection</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">></span></div>
|
|
159
|
+
<div class="tsd-comment tsd-typography"><p>Collection the model uses.</p>
|
|
160
|
+
</div><aside class="tsd-sources">
|
|
161
|
+
<p>Inherited from Document.collection</p>
|
|
162
|
+
<ul>
|
|
163
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-104">node_modules/mongoose/types/document.d.ts:104</a></li></ul></aside></section>
|
|
164
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="db" class="tsd-anchor"></a>
|
|
165
|
+
<h3 class="tsd-anchor-link"><span>db</span><a href="#db" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
166
|
+
<div class="tsd-signature">db<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div>
|
|
167
|
+
<div class="tsd-comment tsd-typography"><p>Connection the model uses.</p>
|
|
168
|
+
</div><aside class="tsd-sources">
|
|
169
|
+
<p>Inherited from Document.db</p>
|
|
170
|
+
<ul>
|
|
171
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-107">node_modules/mongoose/types/document.d.ts:107</a></li></ul></aside></section>
|
|
172
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="errors" class="tsd-anchor"></a>
|
|
173
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>errors</span><a href="#errors" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
174
|
+
<div class="tsd-signature">errors<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ValidationError</span></div>
|
|
175
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current validation errors.</p>
|
|
176
|
+
</div><aside class="tsd-sources">
|
|
177
|
+
<p>Inherited from Document.errors</p>
|
|
178
|
+
<ul>
|
|
179
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-142">node_modules/mongoose/types/document.d.ts:142</a></li></ul></aside></section>
|
|
180
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="id" class="tsd-anchor"></a>
|
|
181
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
182
|
+
<div class="tsd-signature">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div>
|
|
183
|
+
<div class="tsd-comment tsd-typography"><p>The string version of this documents _id.</p>
|
|
184
|
+
</div><aside class="tsd-sources">
|
|
185
|
+
<p>Inherited from Document.id</p>
|
|
186
|
+
<ul>
|
|
187
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-154">node_modules/mongoose/types/document.d.ts:154</a></li></ul></aside></section>
|
|
188
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isNew" class="tsd-anchor"></a>
|
|
189
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>New</span><a href="#isNew" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
190
|
+
<div class="tsd-signature">is<wbr/>New<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
191
|
+
<div class="tsd-comment tsd-typography"><p>Boolean flag specifying if the document is new.</p>
|
|
192
|
+
</div><aside class="tsd-sources">
|
|
193
|
+
<p>Inherited from Document.isNew</p>
|
|
194
|
+
<ul>
|
|
195
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-185">node_modules/mongoose/types/document.d.ts:185</a></li></ul></aside></section>
|
|
196
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="passwordHash" class="tsd-anchor"></a>
|
|
197
|
+
<h3 class="tsd-anchor-link"><span>password<wbr/>Hash</span><a href="#passwordHash" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
198
|
+
<div class="tsd-signature">password<wbr/>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
199
|
+
<ul>
|
|
200
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-22">src/panel/user.ts:22</a></li></ul></aside></section>
|
|
201
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="schema" class="tsd-anchor"></a>
|
|
202
|
+
<h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
203
|
+
<div class="tsd-signature">schema<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Schema</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultSchemaOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></div>
|
|
204
|
+
<div class="tsd-comment tsd-typography"><p>The document's schema.</p>
|
|
205
|
+
</div><aside class="tsd-sources">
|
|
206
|
+
<p>Inherited from Document.schema</p>
|
|
207
|
+
<ul>
|
|
208
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-232">node_modules/mongoose/types/document.d.ts:232</a></li></ul></aside></section>
|
|
209
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="username" class="tsd-anchor"></a>
|
|
210
|
+
<h3 class="tsd-anchor-link"><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
211
|
+
<div class="tsd-signature">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
212
|
+
<ul>
|
|
213
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/src/panel/user.ts#lines-21">src/panel/user.ts:21</a></li></ul></aside></section></section>
|
|
214
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
215
|
+
<h2>Methods</h2>
|
|
216
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_assertPopulated" class="tsd-anchor"></a>
|
|
217
|
+
<h3 class="tsd-anchor-link"><span>$assert<wbr/>Populated</span><a href="#_assertPopulated" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
218
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
219
|
+
<li class="tsd-signature tsd-anchor-link" id="_assertPopulated._assertPopulated-1">$assert<wbr/>Populated<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, values<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><a href="#_assertPopulated._assertPopulated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
220
|
+
<li class="tsd-description">
|
|
221
|
+
<div class="tsd-comment tsd-typography"><p>Assert that a given path or paths is populated. Throws an error if not populated.</p>
|
|
222
|
+
</div>
|
|
223
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
224
|
+
<h4>Type Parameters</h4>
|
|
225
|
+
<ul class="tsd-type-parameters">
|
|
226
|
+
<li>
|
|
227
|
+
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
228
|
+
<div class="tsd-parameters">
|
|
229
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
230
|
+
<ul class="tsd-parameter-list">
|
|
231
|
+
<li>
|
|
232
|
+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
233
|
+
<li>
|
|
234
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> values: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
235
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span></h4><aside class="tsd-sources">
|
|
236
|
+
<p>Inherited from Document.$assertPopulated</p>
|
|
237
|
+
<ul>
|
|
238
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-29">node_modules/mongoose/types/document.d.ts:29</a></li></ul></aside></li></ul></section>
|
|
239
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_clone" class="tsd-anchor"></a>
|
|
240
|
+
<h3 class="tsd-anchor-link"><span>$clone</span><a href="#_clone" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
241
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
242
|
+
<li class="tsd-signature tsd-anchor-link" id="_clone._clone-1">$clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_clone._clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
243
|
+
<li class="tsd-description">
|
|
244
|
+
<div class="tsd-comment tsd-typography"><p>Returns a deep clone of this document</p>
|
|
245
|
+
</div>
|
|
246
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
247
|
+
<p>Inherited from Document.$clone</p>
|
|
248
|
+
<ul>
|
|
249
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-32">node_modules/mongoose/types/document.d.ts:32</a></li></ul></aside></li></ul></section>
|
|
250
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_getAllSubdocs" class="tsd-anchor"></a>
|
|
251
|
+
<h3 class="tsd-anchor-link"><span>$get<wbr/>All<wbr/>Subdocs</span><a href="#_getAllSubdocs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
252
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
253
|
+
<li class="tsd-signature tsd-anchor-link" id="_getAllSubdocs._getAllSubdocs-1">$get<wbr/>All<wbr/>Subdocs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#_getAllSubdocs._getAllSubdocs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
254
|
+
<li class="tsd-description">
|
|
255
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
256
|
+
<p>Inherited from Document.$getAllSubdocs</p>
|
|
257
|
+
<ul>
|
|
258
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-35">node_modules/mongoose/types/document.d.ts:35</a></li></ul></aside></li></ul></section>
|
|
259
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_getPopulatedDocs" class="tsd-anchor"></a>
|
|
260
|
+
<h3 class="tsd-anchor-link"><span>$get<wbr/>Populated<wbr/>Docs</span><a href="#_getPopulatedDocs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
261
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
262
|
+
<li class="tsd-signature tsd-anchor-link" id="_getPopulatedDocs._getPopulatedDocs-1">$get<wbr/>Populated<wbr/>Docs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#_getPopulatedDocs._getPopulatedDocs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
263
|
+
<li class="tsd-description">
|
|
264
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array of all populated documents associated with the query</p>
|
|
265
|
+
</div>
|
|
266
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
267
|
+
<p>Inherited from Document.$getPopulatedDocs</p>
|
|
268
|
+
<ul>
|
|
269
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-47">node_modules/mongoose/types/document.d.ts:47</a></li></ul></aside></li></ul></section>
|
|
270
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_ignore" class="tsd-anchor"></a>
|
|
271
|
+
<h3 class="tsd-anchor-link"><span>$ignore</span><a href="#_ignore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
272
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
273
|
+
<li class="tsd-signature tsd-anchor-link" id="_ignore._ignore-1">$ignore<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_ignore._ignore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
274
|
+
<li class="tsd-description">
|
|
275
|
+
<div class="tsd-comment tsd-typography"><p>Don't run validation on this path or persist changes to this path.</p>
|
|
276
|
+
</div>
|
|
277
|
+
<div class="tsd-parameters">
|
|
278
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
279
|
+
<ul class="tsd-parameter-list">
|
|
280
|
+
<li>
|
|
281
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
282
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
283
|
+
<p>Inherited from Document.$ignore</p>
|
|
284
|
+
<ul>
|
|
285
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-38">node_modules/mongoose/types/document.d.ts:38</a></li></ul></aside></li></ul></section>
|
|
286
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_inc" class="tsd-anchor"></a>
|
|
287
|
+
<h3 class="tsd-anchor-link"><span>$inc</span><a href="#_inc" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
288
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
289
|
+
<li class="tsd-signature tsd-anchor-link" id="_inc._inc-1">$inc<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, val<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_inc._inc-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
290
|
+
<li class="tsd-description">
|
|
291
|
+
<div class="tsd-comment tsd-typography"><p>Increments the numeric value at <code>path</code> by the given <code>val</code>.
|
|
292
|
+
When you call <code>save()</code> on this document, Mongoose will send a
|
|
293
|
+
<code>$inc</code> as opposed to a <code>$set</code>.</p>
|
|
294
|
+
</div>
|
|
295
|
+
<div class="tsd-parameters">
|
|
296
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
297
|
+
<ul class="tsd-parameter-list">
|
|
298
|
+
<li>
|
|
299
|
+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
300
|
+
<li>
|
|
301
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> val: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
|
302
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
303
|
+
<p>Inherited from Document.$inc</p>
|
|
304
|
+
<ul>
|
|
305
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-54">node_modules/mongoose/types/document.d.ts:54</a></li></ul></aside></li></ul></section>
|
|
306
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isDefault" class="tsd-anchor"></a>
|
|
307
|
+
<h3 class="tsd-anchor-link"><span>$is<wbr/>Default</span><a href="#_isDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
308
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
309
|
+
<li class="tsd-signature tsd-anchor-link" id="_isDefault._isDefault-1">$is<wbr/>Default<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isDefault._isDefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
310
|
+
<li class="tsd-description">
|
|
311
|
+
<div class="tsd-comment tsd-typography"><p>Checks if a path is set to its default.</p>
|
|
312
|
+
</div>
|
|
313
|
+
<div class="tsd-parameters">
|
|
314
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
315
|
+
<ul class="tsd-parameter-list">
|
|
316
|
+
<li>
|
|
317
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
318
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
319
|
+
<p>Inherited from Document.$isDefault</p>
|
|
320
|
+
<ul>
|
|
321
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-41">node_modules/mongoose/types/document.d.ts:41</a></li></ul></aside></li></ul></section>
|
|
322
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isDeleted" class="tsd-anchor"></a>
|
|
323
|
+
<h3 class="tsd-anchor-link"><span>$is<wbr/>Deleted</span><a href="#_isDeleted" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
324
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
325
|
+
<li class="tsd-signature tsd-anchor-link" id="_isDeleted._isDeleted-1">$is<wbr/>Deleted<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isDeleted._isDeleted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
326
|
+
<li class="tsd-description">
|
|
327
|
+
<div class="tsd-comment tsd-typography"><p>Getter/setter, determines whether the document was removed or not.</p>
|
|
328
|
+
</div>
|
|
329
|
+
<div class="tsd-parameters">
|
|
330
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
331
|
+
<ul class="tsd-parameter-list">
|
|
332
|
+
<li>
|
|
333
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> val: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
334
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
335
|
+
<p>Inherited from Document.$isDeleted</p>
|
|
336
|
+
<ul>
|
|
337
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-44">node_modules/mongoose/types/document.d.ts:44</a></li></ul></aside></li></ul></section>
|
|
338
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isEmpty" class="tsd-anchor"></a>
|
|
339
|
+
<h3 class="tsd-anchor-link"><span>$is<wbr/>Empty</span><a href="#_isEmpty" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
340
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
341
|
+
<li class="tsd-signature tsd-anchor-link" id="_isEmpty._isEmpty-1">$is<wbr/>Empty<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isEmpty._isEmpty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
342
|
+
<li class="tsd-description">
|
|
343
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the given path is nullish or only contains empty objects.
|
|
344
|
+
Useful for determining whether this subdoc will get stripped out by the
|
|
345
|
+
<a href="/docs/guide.html#minimize">minimize option</a>.</p>
|
|
346
|
+
</div>
|
|
347
|
+
<div class="tsd-parameters">
|
|
348
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
349
|
+
<ul class="tsd-parameter-list">
|
|
350
|
+
<li>
|
|
351
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
352
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
353
|
+
<p>Inherited from Document.$isEmpty</p>
|
|
354
|
+
<ul>
|
|
355
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-61">node_modules/mongoose/types/document.d.ts:61</a></li></ul></aside></li></ul></section>
|
|
356
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_isValid" class="tsd-anchor"></a>
|
|
357
|
+
<h3 class="tsd-anchor-link"><span>$is<wbr/>Valid</span><a href="#_isValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
358
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
359
|
+
<li class="tsd-signature tsd-anchor-link" id="_isValid._isValid-1">$is<wbr/>Valid<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#_isValid._isValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
360
|
+
<li class="tsd-description">
|
|
361
|
+
<div class="tsd-comment tsd-typography"><p>Checks if a path is invalid</p>
|
|
362
|
+
</div>
|
|
363
|
+
<div class="tsd-parameters">
|
|
364
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
365
|
+
<ul class="tsd-parameter-list">
|
|
366
|
+
<li>
|
|
367
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
368
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
369
|
+
<p>Inherited from Document.$isValid</p>
|
|
370
|
+
<ul>
|
|
371
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-64">node_modules/mongoose/types/document.d.ts:64</a></li></ul></aside></li></ul></section>
|
|
372
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_markValid" class="tsd-anchor"></a>
|
|
373
|
+
<h3 class="tsd-anchor-link"><span>$mark<wbr/>Valid</span><a href="#_markValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
374
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
375
|
+
<li class="tsd-signature tsd-anchor-link" id="_markValid._markValid-1">$mark<wbr/>Valid<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_markValid._markValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
376
|
+
<li class="tsd-description">
|
|
377
|
+
<div class="tsd-comment tsd-typography"><p>Marks a path as valid, removing existing validation errors.</p>
|
|
378
|
+
</div>
|
|
379
|
+
<div class="tsd-parameters">
|
|
380
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
381
|
+
<ul class="tsd-parameter-list">
|
|
382
|
+
<li>
|
|
383
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
384
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
385
|
+
<p>Inherited from Document.$markValid</p>
|
|
386
|
+
<ul>
|
|
387
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-74">node_modules/mongoose/types/document.d.ts:74</a></li></ul></aside></li></ul></section>
|
|
388
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_model" class="tsd-anchor"></a>
|
|
389
|
+
<h3 class="tsd-anchor-link"><span>$model</span><a href="#_model" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
390
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
391
|
+
<li class="tsd-signature tsd-anchor-link" id="_model._model-1">$model<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span><a href="#_model._model-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
392
|
+
<li class="tsd-description">
|
|
393
|
+
<div class="tsd-comment tsd-typography"><p>Returns the model with the given name on this document's associated connection.</p>
|
|
394
|
+
</div>
|
|
395
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
396
|
+
<h4>Type Parameters</h4>
|
|
397
|
+
<ul class="tsd-type-parameters">
|
|
398
|
+
<li>
|
|
399
|
+
<h4>ModelType = <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
400
|
+
<div class="tsd-parameters">
|
|
401
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
402
|
+
<ul class="tsd-parameter-list">
|
|
403
|
+
<li>
|
|
404
|
+
<h5>name: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
405
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">ModelType</span></h4><aside class="tsd-sources">
|
|
406
|
+
<p>Inherited from Document.$model</p>
|
|
407
|
+
<ul>
|
|
408
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-77">node_modules/mongoose/types/document.d.ts:77</a></li></ul></aside></li></ul></section>
|
|
409
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_parent" class="tsd-anchor"></a>
|
|
410
|
+
<h3 class="tsd-anchor-link"><span>$parent</span><a href="#_parent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
411
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
412
|
+
<li class="tsd-signature tsd-anchor-link" id="_parent._parent-1">$parent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#_parent._parent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
413
|
+
<li class="tsd-description">
|
|
414
|
+
<div class="tsd-comment tsd-typography"><p>If this document is a subdocument or populated document, returns the
|
|
415
|
+
document's parent. Returns undefined otherwise.</p>
|
|
416
|
+
</div>
|
|
417
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
418
|
+
<p>Inherited from Document.$parent</p>
|
|
419
|
+
<ul>
|
|
420
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-207">node_modules/mongoose/types/document.d.ts:207</a></li></ul></aside></li></ul></section>
|
|
421
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_session" class="tsd-anchor"></a>
|
|
422
|
+
<h3 class="tsd-anchor-link"><span>$session</span><a href="#_session" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
423
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
424
|
+
<li class="tsd-signature tsd-anchor-link" id="_session._session-1">$session<span class="tsd-signature-symbol">(</span>session<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span><a href="#_session._session-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
425
|
+
<li class="tsd-description">
|
|
426
|
+
<div class="tsd-comment tsd-typography"><p>Getter/setter around the session associated with this document. Used to
|
|
427
|
+
automatically set <code>session</code> if you <code>save()</code> a doc that you got from a
|
|
428
|
+
query with an associated session.</p>
|
|
429
|
+
</div>
|
|
430
|
+
<div class="tsd-parameters">
|
|
431
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
432
|
+
<ul class="tsd-parameter-list">
|
|
433
|
+
<li>
|
|
434
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> session: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span></h5></li></ul></div>
|
|
435
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ClientSession</span></h4><aside class="tsd-sources">
|
|
436
|
+
<p>Inherited from Document.$session</p>
|
|
437
|
+
<ul>
|
|
438
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-90">node_modules/mongoose/types/document.d.ts:90</a></li></ul></aside></li></ul></section>
|
|
439
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="_set" class="tsd-anchor"></a>
|
|
440
|
+
<h3 class="tsd-anchor-link"><span>$set</span><a href="#_set" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
441
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
442
|
+
<li class="tsd-signature tsd-anchor-link" id="_set._set-1">$set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DocumentSetOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
443
|
+
<li class="tsd-description">
|
|
444
|
+
<div class="tsd-comment tsd-typography"><p>Alias for <code>set()</code>, used internally to avoid conflicts</p>
|
|
445
|
+
</div>
|
|
446
|
+
<div class="tsd-parameters">
|
|
447
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
448
|
+
<ul class="tsd-parameter-list">
|
|
449
|
+
<li>
|
|
450
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
451
|
+
<li>
|
|
452
|
+
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
453
|
+
<li>
|
|
454
|
+
<h5>type: <span class="tsd-signature-type">any</span></h5></li>
|
|
455
|
+
<li>
|
|
456
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">DocumentSetOptions</span></h5></li></ul></div>
|
|
457
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
458
|
+
<p>Inherited from Document.$set</p>
|
|
459
|
+
<ul>
|
|
460
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-93">node_modules/mongoose/types/document.d.ts:93</a></li></ul></aside></li>
|
|
461
|
+
<li class="tsd-signature tsd-anchor-link" id="_set._set-2">$set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DocumentSetOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
462
|
+
<li class="tsd-description">
|
|
463
|
+
<div class="tsd-parameters">
|
|
464
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
465
|
+
<ul class="tsd-parameter-list">
|
|
466
|
+
<li>
|
|
467
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
468
|
+
<li>
|
|
469
|
+
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
470
|
+
<li>
|
|
471
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">DocumentSetOptions</span></h5></li></ul></div>
|
|
472
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
473
|
+
<p>Inherited from Document.$set</p>
|
|
474
|
+
<ul>
|
|
475
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-94">node_modules/mongoose/types/document.d.ts:94</a></li></ul></aside></li>
|
|
476
|
+
<li class="tsd-signature tsd-anchor-link" id="_set._set-3">$set<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#_set._set-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
477
|
+
<li class="tsd-description">
|
|
478
|
+
<div class="tsd-parameters">
|
|
479
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
480
|
+
<ul class="tsd-parameter-list">
|
|
481
|
+
<li>
|
|
482
|
+
<h5>value: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
483
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
484
|
+
<p>Inherited from Document.$set</p>
|
|
485
|
+
<ul>
|
|
486
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-95">node_modules/mongoose/types/document.d.ts:95</a></li></ul></aside></li></ul></section>
|
|
487
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="delete" class="tsd-anchor"></a>
|
|
488
|
+
<h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
489
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
490
|
+
<li class="tsd-signature tsd-anchor-link" id="delete.delete-1">delete<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
491
|
+
<li class="tsd-description">
|
|
492
|
+
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
493
|
+
</div>
|
|
494
|
+
<div class="tsd-parameters">
|
|
495
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
496
|
+
<ul class="tsd-parameter-list">
|
|
497
|
+
<li>
|
|
498
|
+
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
499
|
+
<li>
|
|
500
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
501
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
502
|
+
<p>Inherited from Document.delete</p>
|
|
503
|
+
<ul>
|
|
504
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-110">node_modules/mongoose/types/document.d.ts:110</a></li></ul></aside></li>
|
|
505
|
+
<li class="tsd-signature tsd-anchor-link" id="delete.delete-2">delete<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#delete.delete-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
506
|
+
<li class="tsd-description">
|
|
507
|
+
<div class="tsd-parameters">
|
|
508
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
509
|
+
<ul class="tsd-parameter-list">
|
|
510
|
+
<li>
|
|
511
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
512
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
513
|
+
<p>Inherited from Document.delete</p>
|
|
514
|
+
<ul>
|
|
515
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-111">node_modules/mongoose/types/document.d.ts:111</a></li></ul></aside></li>
|
|
516
|
+
<li class="tsd-signature tsd-anchor-link" id="delete.delete-3">delete<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#delete.delete-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
517
|
+
<li class="tsd-description">
|
|
518
|
+
<div class="tsd-parameters">
|
|
519
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
520
|
+
<ul class="tsd-parameter-list">
|
|
521
|
+
<li>
|
|
522
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
523
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
524
|
+
<p>Inherited from Document.delete</p>
|
|
525
|
+
<ul>
|
|
526
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-112">node_modules/mongoose/types/document.d.ts:112</a></li></ul></aside></li></ul></section>
|
|
527
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="deleteOne" class="tsd-anchor"></a>
|
|
528
|
+
<h3 class="tsd-anchor-link"><span>delete<wbr/>One</span><a href="#deleteOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
529
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
530
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-1">delete<wbr/>One<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteOne.deleteOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
531
|
+
<li class="tsd-description">
|
|
532
|
+
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
533
|
+
</div>
|
|
534
|
+
<div class="tsd-parameters">
|
|
535
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
536
|
+
<ul class="tsd-parameter-list">
|
|
537
|
+
<li>
|
|
538
|
+
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
539
|
+
<li>
|
|
540
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
541
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
542
|
+
<p>Inherited from Document.deleteOne</p>
|
|
543
|
+
<ul>
|
|
544
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-115">node_modules/mongoose/types/document.d.ts:115</a></li></ul></aside></li>
|
|
545
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-2">delete<wbr/>One<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteOne.deleteOne-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
546
|
+
<li class="tsd-description">
|
|
547
|
+
<div class="tsd-parameters">
|
|
548
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
549
|
+
<ul class="tsd-parameter-list">
|
|
550
|
+
<li>
|
|
551
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
552
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
553
|
+
<p>Inherited from Document.deleteOne</p>
|
|
554
|
+
<ul>
|
|
555
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-116">node_modules/mongoose/types/document.d.ts:116</a></li></ul></aside></li>
|
|
556
|
+
<li class="tsd-signature tsd-anchor-link" id="deleteOne.deleteOne-3">delete<wbr/>One<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#deleteOne.deleteOne-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
557
|
+
<li class="tsd-description">
|
|
558
|
+
<div class="tsd-parameters">
|
|
559
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
560
|
+
<ul class="tsd-parameter-list">
|
|
561
|
+
<li>
|
|
562
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
563
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
564
|
+
<p>Inherited from Document.deleteOne</p>
|
|
565
|
+
<ul>
|
|
566
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-117">node_modules/mongoose/types/document.d.ts:117</a></li></ul></aside></li></ul></section>
|
|
567
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="depopulate" class="tsd-anchor"></a>
|
|
568
|
+
<h3 class="tsd-anchor-link"><span>depopulate</span><a href="#depopulate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
569
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
570
|
+
<li class="tsd-signature tsd-anchor-link" id="depopulate.depopulate-1">depopulate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#depopulate.depopulate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
571
|
+
<li class="tsd-description">
|
|
572
|
+
<div class="tsd-comment tsd-typography"><p>Takes a populated field and returns it to its unpopulated state. If called with
|
|
573
|
+
no arguments, then all populated fields are returned to their unpopulated state.</p>
|
|
574
|
+
</div>
|
|
575
|
+
<div class="tsd-parameters">
|
|
576
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
577
|
+
<ul class="tsd-parameter-list">
|
|
578
|
+
<li>
|
|
579
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
580
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
581
|
+
<p>Inherited from Document.depopulate</p>
|
|
582
|
+
<ul>
|
|
583
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-123">node_modules/mongoose/types/document.d.ts:123</a></li></ul></aside></li></ul></section>
|
|
584
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="directModifiedPaths" class="tsd-anchor"></a>
|
|
585
|
+
<h3 class="tsd-anchor-link"><span>direct<wbr/>Modified<wbr/>Paths</span><a href="#directModifiedPaths" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
586
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
587
|
+
<li class="tsd-signature tsd-anchor-link" id="directModifiedPaths.directModifiedPaths-1">direct<wbr/>Modified<wbr/>Paths<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#directModifiedPaths.directModifiedPaths-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
588
|
+
<li class="tsd-description">
|
|
589
|
+
<div class="tsd-comment tsd-typography"><p>Returns the list of paths that have been directly modified. A direct
|
|
590
|
+
modified path is a path that you explicitly set, whether via <code>doc.foo = 'bar'</code>,
|
|
591
|
+
<code>Object.assign(doc, { foo: 'bar' })</code>, or <code>doc.set('foo', 'bar')</code>.</p>
|
|
592
|
+
</div>
|
|
593
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
594
|
+
<p>Inherited from Document.directModifiedPaths</p>
|
|
595
|
+
<ul>
|
|
596
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-130">node_modules/mongoose/types/document.d.ts:130</a></li></ul></aside></li></ul></section>
|
|
597
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="equals" class="tsd-anchor"></a>
|
|
598
|
+
<h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
599
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
600
|
+
<li class="tsd-signature tsd-anchor-link" id="equals.equals-1">equals<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
601
|
+
<li class="tsd-description">
|
|
602
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if this document is equal to another document.</p>
|
|
603
|
+
<p>Documents are considered equal when they have matching <code>_id</code>s, unless neither
|
|
604
|
+
document has an <code>_id</code>, in which case this function falls back to using
|
|
605
|
+
<code>deepEqual()</code>.</p>
|
|
606
|
+
</div>
|
|
607
|
+
<div class="tsd-parameters">
|
|
608
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
609
|
+
<ul class="tsd-parameter-list">
|
|
610
|
+
<li>
|
|
611
|
+
<h5>doc: <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
612
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
613
|
+
<p>Inherited from Document.equals</p>
|
|
614
|
+
<ul>
|
|
615
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-139">node_modules/mongoose/types/document.d.ts:139</a></li></ul></aside></li></ul></section>
|
|
616
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="get" class="tsd-anchor"></a>
|
|
617
|
+
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
618
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
619
|
+
<li class="tsd-signature tsd-anchor-link" id="get.get-1">get<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
620
|
+
<li class="tsd-description">
|
|
621
|
+
<div class="tsd-comment tsd-typography"><p>Returns the value of a path.</p>
|
|
622
|
+
</div>
|
|
623
|
+
<div class="tsd-parameters">
|
|
624
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
625
|
+
<ul class="tsd-parameter-list">
|
|
626
|
+
<li>
|
|
627
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
628
|
+
<li>
|
|
629
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> type: <span class="tsd-signature-type">any</span></h5></li>
|
|
630
|
+
<li>
|
|
631
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
632
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
633
|
+
<p>Inherited from Document.get</p>
|
|
634
|
+
<ul>
|
|
635
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-145">node_modules/mongoose/types/document.d.ts:145</a></li></ul></aside></li></ul></section>
|
|
636
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="getChanges" class="tsd-anchor"></a>
|
|
637
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Changes</span><a href="#getChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
638
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
639
|
+
<li class="tsd-signature tsd-anchor-link" id="getChanges.getChanges-1">get<wbr/>Changes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#getChanges.getChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
640
|
+
<li class="tsd-description">
|
|
641
|
+
<div class="tsd-comment tsd-typography"><p>Returns the changes that happened to the document
|
|
642
|
+
in the format that will be sent to MongoDB.</p>
|
|
643
|
+
</div>
|
|
644
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
645
|
+
<p>Inherited from Document.getChanges</p>
|
|
646
|
+
<ul>
|
|
647
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-151">node_modules/mongoose/types/document.d.ts:151</a></li></ul></aside></li></ul></section>
|
|
648
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="increment" class="tsd-anchor"></a>
|
|
649
|
+
<h3 class="tsd-anchor-link"><span>increment</span><a href="#increment" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
650
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
651
|
+
<li class="tsd-signature tsd-anchor-link" id="increment.increment-1">increment<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#increment.increment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
652
|
+
<li class="tsd-description">
|
|
653
|
+
<div class="tsd-comment tsd-typography"><p>Signal that we desire an increment of this documents version.</p>
|
|
654
|
+
</div>
|
|
655
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
656
|
+
<p>Inherited from Document.increment</p>
|
|
657
|
+
<ul>
|
|
658
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-157">node_modules/mongoose/types/document.d.ts:157</a></li></ul></aside></li></ul></section>
|
|
659
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="init" class="tsd-anchor"></a>
|
|
660
|
+
<h3 class="tsd-anchor-link"><span>init</span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
661
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
662
|
+
<li class="tsd-signature tsd-anchor-link" id="init.init-1">init<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#init.init-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
663
|
+
<li class="tsd-description">
|
|
664
|
+
<div class="tsd-comment tsd-typography"><p>Initializes the document without setters or marking anything modified.
|
|
665
|
+
Called internally after a document is returned from mongodb. Normally,
|
|
666
|
+
you do <strong>not</strong> need to call this function on your own.</p>
|
|
667
|
+
</div>
|
|
668
|
+
<div class="tsd-parameters">
|
|
669
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
670
|
+
<ul class="tsd-parameter-list">
|
|
671
|
+
<li>
|
|
672
|
+
<h5>obj: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
673
|
+
<li>
|
|
674
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
675
|
+
<li>
|
|
676
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
677
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
678
|
+
<p>Inherited from Document.init</p>
|
|
679
|
+
<ul>
|
|
680
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-164">node_modules/mongoose/types/document.d.ts:164</a></li></ul></aside></li></ul></section>
|
|
681
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="invalidate" class="tsd-anchor"></a>
|
|
682
|
+
<h3 class="tsd-anchor-link"><span>invalidate</span><a href="#invalidate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
683
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
684
|
+
<li class="tsd-signature tsd-anchor-link" id="invalidate.invalidate-1">invalidate<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, errorMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, kind<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span><a href="#invalidate.invalidate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
685
|
+
<li class="tsd-description">
|
|
686
|
+
<div class="tsd-comment tsd-typography"><p>Marks a path as invalid, causing validation to fail.</p>
|
|
687
|
+
</div>
|
|
688
|
+
<div class="tsd-parameters">
|
|
689
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
690
|
+
<ul class="tsd-parameter-list">
|
|
691
|
+
<li>
|
|
692
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
693
|
+
<li>
|
|
694
|
+
<h5>errorMsg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span></h5></li>
|
|
695
|
+
<li>
|
|
696
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> value: <span class="tsd-signature-type">any</span></h5></li>
|
|
697
|
+
<li>
|
|
698
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> kind: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
699
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NativeError</span></h4><aside class="tsd-sources">
|
|
700
|
+
<p>Inherited from Document.invalidate</p>
|
|
701
|
+
<ul>
|
|
702
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-167">node_modules/mongoose/types/document.d.ts:167</a></li></ul></aside></li></ul></section>
|
|
703
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isDirectModified" class="tsd-anchor"></a>
|
|
704
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Direct<wbr/>Modified</span><a href="#isDirectModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
705
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
706
|
+
<li class="tsd-signature tsd-anchor-link" id="isDirectModified.isDirectModified-1">is<wbr/>Direct<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isDirectModified.isDirectModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
707
|
+
<li class="tsd-description">
|
|
708
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if <code>path</code> was directly set and modified, else false.</p>
|
|
709
|
+
</div>
|
|
710
|
+
<div class="tsd-parameters">
|
|
711
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
712
|
+
<ul class="tsd-parameter-list">
|
|
713
|
+
<li>
|
|
714
|
+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
715
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
716
|
+
<p>Inherited from Document.isDirectModified</p>
|
|
717
|
+
<ul>
|
|
718
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-170">node_modules/mongoose/types/document.d.ts:170</a></li></ul></aside></li></ul></section>
|
|
719
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isDirectSelected" class="tsd-anchor"></a>
|
|
720
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Direct<wbr/>Selected</span><a href="#isDirectSelected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
721
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
722
|
+
<li class="tsd-signature tsd-anchor-link" id="isDirectSelected.isDirectSelected-1">is<wbr/>Direct<wbr/>Selected<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isDirectSelected.isDirectSelected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
723
|
+
<li class="tsd-description">
|
|
724
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> was explicitly selected. If no projection, always returns true.</p>
|
|
725
|
+
</div>
|
|
726
|
+
<div class="tsd-parameters">
|
|
727
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
728
|
+
<ul class="tsd-parameter-list">
|
|
729
|
+
<li>
|
|
730
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
731
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
732
|
+
<p>Inherited from Document.isDirectSelected</p>
|
|
733
|
+
<ul>
|
|
734
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-173">node_modules/mongoose/types/document.d.ts:173</a></li></ul></aside></li></ul></section>
|
|
735
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isInit" class="tsd-anchor"></a>
|
|
736
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Init</span><a href="#isInit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
737
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
738
|
+
<li class="tsd-signature tsd-anchor-link" id="isInit.isInit-1">is<wbr/>Init<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isInit.isInit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
739
|
+
<li class="tsd-description">
|
|
740
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> is in the <code>init</code> state, that is, it was set by <code>Document#init()</code> and not modified since.</p>
|
|
741
|
+
</div>
|
|
742
|
+
<div class="tsd-parameters">
|
|
743
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
744
|
+
<ul class="tsd-parameter-list">
|
|
745
|
+
<li>
|
|
746
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
747
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
748
|
+
<p>Inherited from Document.isInit</p>
|
|
749
|
+
<ul>
|
|
750
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-176">node_modules/mongoose/types/document.d.ts:176</a></li></ul></aside></li></ul></section>
|
|
751
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isModified" class="tsd-anchor"></a>
|
|
752
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Modified</span><a href="#isModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
753
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
754
|
+
<li class="tsd-signature tsd-anchor-link" id="isModified.isModified-1">is<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isModified.isModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
755
|
+
<li class="tsd-description">
|
|
756
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if any of the given paths are modified, else false. If no arguments, returns <code>true</code> if any path
|
|
757
|
+
in this document is modified.</p>
|
|
758
|
+
</div>
|
|
759
|
+
<div class="tsd-parameters">
|
|
760
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
761
|
+
<ul class="tsd-parameter-list">
|
|
762
|
+
<li>
|
|
763
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
764
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
765
|
+
<p>Inherited from Document.isModified</p>
|
|
766
|
+
<ul>
|
|
767
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-182">node_modules/mongoose/types/document.d.ts:182</a></li></ul></aside></li></ul></section>
|
|
768
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="isSelected" class="tsd-anchor"></a>
|
|
769
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Selected</span><a href="#isSelected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
770
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
771
|
+
<li class="tsd-signature tsd-anchor-link" id="isSelected.isSelected-1">is<wbr/>Selected<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isSelected.isSelected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
772
|
+
<li class="tsd-description">
|
|
773
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>path</code> was selected in the source query which initialized this document.</p>
|
|
774
|
+
</div>
|
|
775
|
+
<div class="tsd-parameters">
|
|
776
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
777
|
+
<ul class="tsd-parameter-list">
|
|
778
|
+
<li>
|
|
779
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
780
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
781
|
+
<p>Inherited from Document.isSelected</p>
|
|
782
|
+
<ul>
|
|
783
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-188">node_modules/mongoose/types/document.d.ts:188</a></li></ul></aside></li></ul></section>
|
|
784
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="markModified" class="tsd-anchor"></a>
|
|
785
|
+
<h3 class="tsd-anchor-link"><span>mark<wbr/>Modified</span><a href="#markModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
786
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
787
|
+
<li class="tsd-signature tsd-anchor-link" id="markModified.markModified-1">mark<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#markModified.markModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
788
|
+
<li class="tsd-description">
|
|
789
|
+
<div class="tsd-comment tsd-typography"><p>Marks the path as having pending changes to write to the db.</p>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="tsd-parameters">
|
|
792
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
793
|
+
<ul class="tsd-parameter-list">
|
|
794
|
+
<li>
|
|
795
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
796
|
+
<li>
|
|
797
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> scope: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
798
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
799
|
+
<p>Inherited from Document.markModified</p>
|
|
800
|
+
<ul>
|
|
801
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-191">node_modules/mongoose/types/document.d.ts:191</a></li></ul></aside></li></ul></section>
|
|
802
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="modifiedPaths" class="tsd-anchor"></a>
|
|
803
|
+
<h3 class="tsd-anchor-link"><span>modified<wbr/>Paths</span><a href="#modifiedPaths" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
804
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
805
|
+
<li class="tsd-signature tsd-anchor-link" id="modifiedPaths.modifiedPaths-1">modified<wbr/>Paths<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>includeChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#modifiedPaths.modifiedPaths-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
806
|
+
<li class="tsd-description">
|
|
807
|
+
<div class="tsd-comment tsd-typography"><p>Returns the list of paths that have been modified.</p>
|
|
808
|
+
</div>
|
|
809
|
+
<div class="tsd-parameters">
|
|
810
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
811
|
+
<ul class="tsd-parameter-list">
|
|
812
|
+
<li>
|
|
813
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>includeChildren<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
814
|
+
<ul class="tsd-parameters">
|
|
815
|
+
<li class="tsd-parameter">
|
|
816
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> include<wbr/>Children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
|
|
817
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
818
|
+
<p>Inherited from Document.modifiedPaths</p>
|
|
819
|
+
<ul>
|
|
820
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-194">node_modules/mongoose/types/document.d.ts:194</a></li></ul></aside></li></ul></section>
|
|
821
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="overwrite" class="tsd-anchor"></a>
|
|
822
|
+
<h3 class="tsd-anchor-link"><span>overwrite</span><a href="#overwrite" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
823
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
824
|
+
<li class="tsd-signature tsd-anchor-link" id="overwrite.overwrite-1">overwrite<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#overwrite.overwrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
825
|
+
<li class="tsd-description">
|
|
826
|
+
<div class="tsd-comment tsd-typography"><p>Overwrite all values in this document with the values of <code>obj</code>, except
|
|
827
|
+
for immutable properties. Behaves similarly to <code>set()</code>, except for it
|
|
828
|
+
unsets all properties that aren't in <code>obj</code>.</p>
|
|
829
|
+
</div>
|
|
830
|
+
<div class="tsd-parameters">
|
|
831
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
832
|
+
<ul class="tsd-parameter-list">
|
|
833
|
+
<li>
|
|
834
|
+
<h5>obj: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
835
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
836
|
+
<p>Inherited from Document.overwrite</p>
|
|
837
|
+
<ul>
|
|
838
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-201">node_modules/mongoose/types/document.d.ts:201</a></li></ul></aside></li></ul></section>
|
|
839
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="populate" class="tsd-anchor"></a>
|
|
840
|
+
<h3 class="tsd-anchor-link"><span>populate</span><a href="#populate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
841
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
842
|
+
<li class="tsd-signature tsd-anchor-link" id="populate.populate-1">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#populate.populate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
843
|
+
<li class="tsd-description">
|
|
844
|
+
<div class="tsd-comment tsd-typography"><p>Populates document references.</p>
|
|
845
|
+
</div>
|
|
846
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
847
|
+
<h4>Type Parameters</h4>
|
|
848
|
+
<ul class="tsd-type-parameters">
|
|
849
|
+
<li>
|
|
850
|
+
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
851
|
+
<div class="tsd-parameters">
|
|
852
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
853
|
+
<ul class="tsd-parameter-list">
|
|
854
|
+
<li>
|
|
855
|
+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
856
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
857
|
+
<p>Inherited from Document.populate</p>
|
|
858
|
+
<ul>
|
|
859
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-210">node_modules/mongoose/types/document.d.ts:210</a></li></ul></aside></li>
|
|
860
|
+
<li class="tsd-signature tsd-anchor-link" id="populate.populate-2">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#populate.populate-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
861
|
+
<li class="tsd-description">
|
|
862
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
863
|
+
<h4>Type Parameters</h4>
|
|
864
|
+
<ul class="tsd-type-parameters">
|
|
865
|
+
<li>
|
|
866
|
+
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
867
|
+
<div class="tsd-parameters">
|
|
868
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
869
|
+
<ul class="tsd-parameter-list">
|
|
870
|
+
<li>
|
|
871
|
+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
|
872
|
+
<li>
|
|
873
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
874
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
875
|
+
<p>Inherited from Document.populate</p>
|
|
876
|
+
<ul>
|
|
877
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-211">node_modules/mongoose/types/document.d.ts:211</a></li></ul></aside></li>
|
|
878
|
+
<li class="tsd-signature tsd-anchor-link" id="populate.populate-3">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span>, model<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, match<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PopulateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#populate.populate-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
879
|
+
<li class="tsd-description">
|
|
880
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
881
|
+
<h4>Type Parameters</h4>
|
|
882
|
+
<ul class="tsd-type-parameters">
|
|
883
|
+
<li>
|
|
884
|
+
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
885
|
+
<div class="tsd-parameters">
|
|
886
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
887
|
+
<ul class="tsd-parameter-list">
|
|
888
|
+
<li>
|
|
889
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
890
|
+
<li>
|
|
891
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> select: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
892
|
+
<li>
|
|
893
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> model: <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
894
|
+
<li>
|
|
895
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> match: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
896
|
+
<li>
|
|
897
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">PopulateOptions</span></h5></li></ul></div>
|
|
898
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
899
|
+
<p>Inherited from Document.populate</p>
|
|
900
|
+
<ul>
|
|
901
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-212">node_modules/mongoose/types/document.d.ts:212</a></li></ul></aside></li>
|
|
902
|
+
<li class="tsd-signature tsd-anchor-link" id="populate.populate-4">populate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span>, model<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, match<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PopulateOptions</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#populate.populate-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
903
|
+
<li class="tsd-description">
|
|
904
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
905
|
+
<h4>Type Parameters</h4>
|
|
906
|
+
<ul class="tsd-type-parameters">
|
|
907
|
+
<li>
|
|
908
|
+
<h4>Paths = <span class="tsd-signature-symbol">{}</span></h4></li></ul></section>
|
|
909
|
+
<div class="tsd-parameters">
|
|
910
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
911
|
+
<ul class="tsd-parameter-list">
|
|
912
|
+
<li>
|
|
913
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
914
|
+
<li>
|
|
915
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> select: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
916
|
+
<li>
|
|
917
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> model: <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
918
|
+
<li>
|
|
919
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> match: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
920
|
+
<li>
|
|
921
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">PopulateOptions</span></h5></li>
|
|
922
|
+
<li>
|
|
923
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MergeType</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Paths</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
924
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
925
|
+
<p>Inherited from Document.populate</p>
|
|
926
|
+
<ul>
|
|
927
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-213">node_modules/mongoose/types/document.d.ts:213</a></li></ul></aside></li></ul></section>
|
|
928
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="populated" class="tsd-anchor"></a>
|
|
929
|
+
<h3 class="tsd-anchor-link"><span>populated</span><a href="#populated" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
930
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
931
|
+
<li class="tsd-signature tsd-anchor-link" id="populated.populated-1">populated<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#populated.populated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
932
|
+
<li class="tsd-description">
|
|
933
|
+
<div class="tsd-comment tsd-typography"><p>Gets _id(s) used during population of the given <code>path</code>. If the path was not populated, returns <code>undefined</code>.</p>
|
|
934
|
+
</div>
|
|
935
|
+
<div class="tsd-parameters">
|
|
936
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
937
|
+
<ul class="tsd-parameter-list">
|
|
938
|
+
<li>
|
|
939
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
940
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
941
|
+
<p>Inherited from Document.populated</p>
|
|
942
|
+
<ul>
|
|
943
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-216">node_modules/mongoose/types/document.d.ts:216</a></li></ul></aside></li></ul></section>
|
|
944
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="remove" class="tsd-anchor"></a>
|
|
945
|
+
<h3 class="tsd-anchor-link"><span>remove</span><a href="#remove" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
946
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
947
|
+
<li class="tsd-signature tsd-anchor-link" id="remove.remove-1">remove<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#remove.remove-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
948
|
+
<li class="tsd-description">
|
|
949
|
+
<div class="tsd-comment tsd-typography"><p>Removes this document from the db.</p>
|
|
950
|
+
</div>
|
|
951
|
+
<div class="tsd-parameters">
|
|
952
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
953
|
+
<ul class="tsd-parameter-list">
|
|
954
|
+
<li>
|
|
955
|
+
<h5>options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
956
|
+
<li>
|
|
957
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
958
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
959
|
+
<p>Inherited from Document.remove</p>
|
|
960
|
+
<ul>
|
|
961
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-219">node_modules/mongoose/types/document.d.ts:219</a></li></ul></aside></li>
|
|
962
|
+
<li class="tsd-signature tsd-anchor-link" id="remove.remove-2">remove<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#remove.remove-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
963
|
+
<li class="tsd-description">
|
|
964
|
+
<div class="tsd-parameters">
|
|
965
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
966
|
+
<ul class="tsd-parameter-list">
|
|
967
|
+
<li>
|
|
968
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
969
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
970
|
+
<p>Inherited from Document.remove</p>
|
|
971
|
+
<ul>
|
|
972
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-220">node_modules/mongoose/types/document.d.ts:220</a></li></ul></aside></li>
|
|
973
|
+
<li class="tsd-signature tsd-anchor-link" id="remove.remove-3">remove<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#remove.remove-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
974
|
+
<li class="tsd-description">
|
|
975
|
+
<div class="tsd-parameters">
|
|
976
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
977
|
+
<ul class="tsd-parameter-list">
|
|
978
|
+
<li>
|
|
979
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
980
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
981
|
+
<p>Inherited from Document.remove</p>
|
|
982
|
+
<ul>
|
|
983
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-221">node_modules/mongoose/types/document.d.ts:221</a></li></ul></aside></li></ul></section>
|
|
984
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="replaceOne" class="tsd-anchor"></a>
|
|
985
|
+
<h3 class="tsd-anchor-link"><span>replace<wbr/>One</span><a href="#replaceOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
986
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
987
|
+
<li class="tsd-signature tsd-anchor-link" id="replaceOne.replaceOne-1">replace<wbr/>One<span class="tsd-signature-symbol">(</span>replacement<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#replaceOne.replaceOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
988
|
+
<li class="tsd-description">
|
|
989
|
+
<div class="tsd-comment tsd-typography"><p>Sends a replaceOne command with this document <code>_id</code> as the query selector.</p>
|
|
990
|
+
</div>
|
|
991
|
+
<div class="tsd-parameters">
|
|
992
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
993
|
+
<ul class="tsd-parameter-list">
|
|
994
|
+
<li>
|
|
995
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> replacement: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
996
|
+
<li>
|
|
997
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
998
|
+
<li>
|
|
999
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1000
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1001
|
+
<p>Inherited from Document.replaceOne</p>
|
|
1002
|
+
<ul>
|
|
1003
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-224">node_modules/mongoose/types/document.d.ts:224</a></li></ul></aside></li></ul></section>
|
|
1004
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="save" class="tsd-anchor"></a>
|
|
1005
|
+
<h3 class="tsd-anchor-link"><span>save</span><a href="#save" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1006
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1007
|
+
<li class="tsd-signature tsd-anchor-link" id="save.save-1">save<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SaveOptions</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#save.save-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1008
|
+
<li class="tsd-description">
|
|
1009
|
+
<div class="tsd-comment tsd-typography"><p>Saves this document by inserting a new document into the database if <a href="/docs/api/document.html#document_Document-isNew">document.isNew</a> is <code>true</code>, or sends an <a href="/docs/api/document.html#document_Document-updateOne">updateOne</a> operation with just the modified paths if <code>isNew</code> is <code>false</code>.</p>
|
|
1010
|
+
</div>
|
|
1011
|
+
<div class="tsd-parameters">
|
|
1012
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1013
|
+
<ul class="tsd-parameter-list">
|
|
1014
|
+
<li>
|
|
1015
|
+
<h5>options: <span class="tsd-signature-type">SaveOptions</span></h5></li>
|
|
1016
|
+
<li>
|
|
1017
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1018
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1019
|
+
<p>Inherited from Document.save</p>
|
|
1020
|
+
<ul>
|
|
1021
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-227">node_modules/mongoose/types/document.d.ts:227</a></li></ul></aside></li>
|
|
1022
|
+
<li class="tsd-signature tsd-anchor-link" id="save.save-2">save<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#save.save-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1023
|
+
<li class="tsd-description">
|
|
1024
|
+
<div class="tsd-parameters">
|
|
1025
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1026
|
+
<ul class="tsd-parameter-list">
|
|
1027
|
+
<li>
|
|
1028
|
+
<h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1029
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1030
|
+
<p>Inherited from Document.save</p>
|
|
1031
|
+
<ul>
|
|
1032
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-228">node_modules/mongoose/types/document.d.ts:228</a></li></ul></aside></li>
|
|
1033
|
+
<li class="tsd-signature tsd-anchor-link" id="save.save-3">save<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SaveOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#save.save-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1034
|
+
<li class="tsd-description">
|
|
1035
|
+
<div class="tsd-parameters">
|
|
1036
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1037
|
+
<ul class="tsd-parameter-list">
|
|
1038
|
+
<li>
|
|
1039
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SaveOptions</span></h5></li></ul></div>
|
|
1040
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1041
|
+
<p>Inherited from Document.save</p>
|
|
1042
|
+
<ul>
|
|
1043
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-229">node_modules/mongoose/types/document.d.ts:229</a></li></ul></aside></li></ul></section>
|
|
1044
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="set" class="tsd-anchor"></a>
|
|
1045
|
+
<h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1046
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1047
|
+
<li class="tsd-signature tsd-anchor-link" id="set.set-1">set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1048
|
+
<li class="tsd-description">
|
|
1049
|
+
<div class="tsd-comment tsd-typography"><p>Sets the value of a path, or many paths.</p>
|
|
1050
|
+
</div>
|
|
1051
|
+
<div class="tsd-parameters">
|
|
1052
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1053
|
+
<ul class="tsd-parameter-list">
|
|
1054
|
+
<li>
|
|
1055
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
1056
|
+
<li>
|
|
1057
|
+
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
1058
|
+
<li>
|
|
1059
|
+
<h5>type: <span class="tsd-signature-type">any</span></h5></li>
|
|
1060
|
+
<li>
|
|
1061
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1062
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1063
|
+
<p>Inherited from Document.set</p>
|
|
1064
|
+
<ul>
|
|
1065
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-235">node_modules/mongoose/types/document.d.ts:235</a></li></ul></aside></li>
|
|
1066
|
+
<li class="tsd-signature tsd-anchor-link" id="set.set-2">set<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1067
|
+
<li class="tsd-description">
|
|
1068
|
+
<div class="tsd-parameters">
|
|
1069
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1070
|
+
<ul class="tsd-parameter-list">
|
|
1071
|
+
<li>
|
|
1072
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li>
|
|
1073
|
+
<li>
|
|
1074
|
+
<h5>val: <span class="tsd-signature-type">any</span></h5></li>
|
|
1075
|
+
<li>
|
|
1076
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1077
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1078
|
+
<p>Inherited from Document.set</p>
|
|
1079
|
+
<ul>
|
|
1080
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-236">node_modules/mongoose/types/document.d.ts:236</a></li></ul></aside></li>
|
|
1081
|
+
<li class="tsd-signature tsd-anchor-link" id="set.set-3">set<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><a href="#set.set-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1082
|
+
<li class="tsd-description">
|
|
1083
|
+
<div class="tsd-parameters">
|
|
1084
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1085
|
+
<ul class="tsd-parameter-list">
|
|
1086
|
+
<li>
|
|
1087
|
+
<h5>value: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1088
|
+
<h4 class="tsd-returns-title">Returns <a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a></h4><aside class="tsd-sources">
|
|
1089
|
+
<p>Inherited from Document.set</p>
|
|
1090
|
+
<ul>
|
|
1091
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-237">node_modules/mongoose/types/document.d.ts:237</a></li></ul></aside></li></ul></section>
|
|
1092
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a>
|
|
1093
|
+
<h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1094
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1095
|
+
<li class="tsd-signature tsd-anchor-link" id="toJSON.toJSON-1">toJSON<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FlattenMaps</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1096
|
+
<li class="tsd-description">
|
|
1097
|
+
<div class="tsd-comment tsd-typography"><p>The return value of this method is used in calls to JSON.stringify(doc).</p>
|
|
1098
|
+
</div>
|
|
1099
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
1100
|
+
<h4>Type Parameters</h4>
|
|
1101
|
+
<ul class="tsd-type-parameters">
|
|
1102
|
+
<li>
|
|
1103
|
+
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1104
|
+
<div class="tsd-parameters">
|
|
1105
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1106
|
+
<ul class="tsd-parameter-list">
|
|
1107
|
+
<li>
|
|
1108
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5></li></ul></div>
|
|
1109
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FlattenMaps</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1110
|
+
<p>Inherited from Document.toJSON</p>
|
|
1111
|
+
<ul>
|
|
1112
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-240">node_modules/mongoose/types/document.d.ts:240</a></li></ul></aside></li>
|
|
1113
|
+
<li class="tsd-signature tsd-anchor-link" id="toJSON.toJSON-2">toJSON<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><a href="#toJSON.toJSON-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1114
|
+
<li class="tsd-description">
|
|
1115
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
1116
|
+
<h4>Type Parameters</h4>
|
|
1117
|
+
<ul class="tsd-type-parameters">
|
|
1118
|
+
<li>
|
|
1119
|
+
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1120
|
+
<div class="tsd-parameters">
|
|
1121
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1122
|
+
<ul class="tsd-parameter-list">
|
|
1123
|
+
<li>
|
|
1124
|
+
<h5>options: <span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>flattenMaps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5></li></ul></div>
|
|
1125
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><aside class="tsd-sources">
|
|
1126
|
+
<p>Inherited from Document.toJSON</p>
|
|
1127
|
+
<ul>
|
|
1128
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-241">node_modules/mongoose/types/document.d.ts:241</a></li></ul></aside></li></ul></section>
|
|
1129
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="toObject" class="tsd-anchor"></a>
|
|
1130
|
+
<h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toObject" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1131
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1132
|
+
<li class="tsd-signature tsd-anchor-link" id="toObject.toObject-1">to<wbr/>Object<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ToObjectOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Require_id</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#toObject.toObject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1133
|
+
<li class="tsd-description">
|
|
1134
|
+
<div class="tsd-comment tsd-typography"><p>Converts this document into a plain-old JavaScript object (<a href="https://masteringjs.io/tutorials/fundamentals/pojo">POJO</a>).</p>
|
|
1135
|
+
</div>
|
|
1136
|
+
<section class="tsd-panel tsd-type-parameters">
|
|
1137
|
+
<h4>Type Parameters</h4>
|
|
1138
|
+
<ul class="tsd-type-parameters">
|
|
1139
|
+
<li>
|
|
1140
|
+
<h4>T = <span class="tsd-signature-type">LeanDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
1141
|
+
<div class="tsd-parameters">
|
|
1142
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1143
|
+
<ul class="tsd-parameter-list">
|
|
1144
|
+
<li>
|
|
1145
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ToObjectOptions</span></h5></li></ul></div>
|
|
1146
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Require_id</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1147
|
+
<p>Inherited from Document.toObject</p>
|
|
1148
|
+
<ul>
|
|
1149
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-244">node_modules/mongoose/types/document.d.ts:244</a></li></ul></aside></li></ul></section>
|
|
1150
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="unmarkModified" class="tsd-anchor"></a>
|
|
1151
|
+
<h3 class="tsd-anchor-link"><span>unmark<wbr/>Modified</span><a href="#unmarkModified" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1152
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1153
|
+
<li class="tsd-signature tsd-anchor-link" id="unmarkModified.unmarkModified-1">unmark<wbr/>Modified<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmarkModified.unmarkModified-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1154
|
+
<li class="tsd-description">
|
|
1155
|
+
<div class="tsd-comment tsd-typography"><p>Clears the modified state on the specified path.</p>
|
|
1156
|
+
</div>
|
|
1157
|
+
<div class="tsd-parameters">
|
|
1158
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1159
|
+
<ul class="tsd-parameter-list">
|
|
1160
|
+
<li>
|
|
1161
|
+
<h5>path: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
1162
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1163
|
+
<p>Inherited from Document.unmarkModified</p>
|
|
1164
|
+
<ul>
|
|
1165
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-247">node_modules/mongoose/types/document.d.ts:247</a></li></ul></aside></li></ul></section>
|
|
1166
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="update" class="tsd-anchor"></a>
|
|
1167
|
+
<h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1168
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1169
|
+
<li class="tsd-signature tsd-anchor-link" id="update.update-1">update<span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#update.update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1170
|
+
<li class="tsd-description">
|
|
1171
|
+
<div class="tsd-comment tsd-typography"><p>Sends an update command with this document <code>_id</code> as the query selector.</p>
|
|
1172
|
+
</div>
|
|
1173
|
+
<div class="tsd-parameters">
|
|
1174
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1175
|
+
<ul class="tsd-parameter-list">
|
|
1176
|
+
<li>
|
|
1177
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> update: <span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li>
|
|
1178
|
+
<li>
|
|
1179
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
1180
|
+
<li>
|
|
1181
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1182
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1183
|
+
<p>Inherited from Document.update</p>
|
|
1184
|
+
<ul>
|
|
1185
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-250">node_modules/mongoose/types/document.d.ts:250</a></li></ul></aside></li></ul></section>
|
|
1186
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="updateOne" class="tsd-anchor"></a>
|
|
1187
|
+
<h3 class="tsd-anchor-link"><span>update<wbr/>One</span><a href="#updateOne" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1188
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1189
|
+
<li class="tsd-signature tsd-anchor-link" id="updateOne.updateOne-1">update<wbr/>One<span class="tsd-signature-symbol">(</span>update<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span><a href="#updateOne.updateOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1190
|
+
<li class="tsd-description">
|
|
1191
|
+
<div class="tsd-comment tsd-typography"><p>Sends an updateOne command with this document <code>_id</code> as the query selector.</p>
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="tsd-parameters">
|
|
1194
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1195
|
+
<ul class="tsd-parameter-list">
|
|
1196
|
+
<li>
|
|
1197
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> update: <span class="tsd-signature-type">UpdateWithAggregationPipeline</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">UpdateQuery</span><span class="tsd-signature-symbol"><</span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h5></li>
|
|
1198
|
+
<li>
|
|
1199
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li>
|
|
1200
|
+
<li>
|
|
1201
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
1202
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><a href="IPanelUser.html" class="tsd-signature-type" data-tsd-kind="Interface">IPanelUser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1203
|
+
<p>Inherited from Document.updateOne</p>
|
|
1204
|
+
<ul>
|
|
1205
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-253">node_modules/mongoose/types/document.d.ts:253</a></li></ul></aside></li></ul></section>
|
|
1206
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="validate" class="tsd-anchor"></a>
|
|
1207
|
+
<h3 class="tsd-anchor-link"><span>validate</span><a href="#validate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1208
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1209
|
+
<li class="tsd-signature tsd-anchor-link" id="validate.validate-1">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnyObject</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1210
|
+
<li class="tsd-description">
|
|
1211
|
+
<div class="tsd-comment tsd-typography"><p>Executes registered validation rules for this document.</p>
|
|
1212
|
+
</div>
|
|
1213
|
+
<div class="tsd-parameters">
|
|
1214
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1215
|
+
<ul class="tsd-parameter-list">
|
|
1216
|
+
<li>
|
|
1217
|
+
<h5>pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1218
|
+
<li>
|
|
1219
|
+
<h5>options: <span class="tsd-signature-type">AnyObject</span></h5></li>
|
|
1220
|
+
<li>
|
|
1221
|
+
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1222
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1223
|
+
<p>Inherited from Document.validate</p>
|
|
1224
|
+
<ul>
|
|
1225
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-256">node_modules/mongoose/types/document.d.ts:256</a></li></ul></aside></li>
|
|
1226
|
+
<li class="tsd-signature tsd-anchor-link" id="validate.validate-2">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathsToValidate</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1227
|
+
<li class="tsd-description">
|
|
1228
|
+
<div class="tsd-parameters">
|
|
1229
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1230
|
+
<ul class="tsd-parameter-list">
|
|
1231
|
+
<li>
|
|
1232
|
+
<h5>pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1233
|
+
<li>
|
|
1234
|
+
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1235
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1236
|
+
<p>Inherited from Document.validate</p>
|
|
1237
|
+
<ul>
|
|
1238
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-257">node_modules/mongoose/types/document.d.ts:257</a></li></ul></aside></li>
|
|
1239
|
+
<li class="tsd-signature tsd-anchor-link" id="validate.validate-3">validate<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallbackWithoutResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validate.validate-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1240
|
+
<li class="tsd-description">
|
|
1241
|
+
<div class="tsd-parameters">
|
|
1242
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1243
|
+
<ul class="tsd-parameter-list">
|
|
1244
|
+
<li>
|
|
1245
|
+
<h5>callback: <span class="tsd-signature-type">CallbackWithoutResult</span></h5></li></ul></div>
|
|
1246
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1247
|
+
<p>Inherited from Document.validate</p>
|
|
1248
|
+
<ul>
|
|
1249
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-258">node_modules/mongoose/types/document.d.ts:258</a></li></ul></aside></li>
|
|
1250
|
+
<li class="tsd-signature tsd-anchor-link" id="validate.validate-4">validate<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validate.validate-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1251
|
+
<li class="tsd-description">
|
|
1252
|
+
<div class="tsd-parameters">
|
|
1253
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1254
|
+
<ul class="tsd-parameter-list">
|
|
1255
|
+
<li>
|
|
1256
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1257
|
+
<li>
|
|
1258
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
1259
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1260
|
+
<p>Inherited from Document.validate</p>
|
|
1261
|
+
<ul>
|
|
1262
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-259">node_modules/mongoose/types/document.d.ts:259</a></li></ul></aside></li>
|
|
1263
|
+
<li class="tsd-signature tsd-anchor-link" id="validate.validate-5">validate<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validate.validate-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1264
|
+
<li class="tsd-description">
|
|
1265
|
+
<div class="tsd-parameters">
|
|
1266
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1267
|
+
<ul class="tsd-parameter-list">
|
|
1268
|
+
<li>
|
|
1269
|
+
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
1270
|
+
<ul class="tsd-parameters">
|
|
1271
|
+
<li class="tsd-parameter">
|
|
1272
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> paths<wbr/>To<wbr/>Skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span></h5></li></ul></li></ul></div>
|
|
1273
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1274
|
+
<p>Inherited from Document.validate</p>
|
|
1275
|
+
<ul>
|
|
1276
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-260">node_modules/mongoose/types/document.d.ts:260</a></li></ul></aside></li></ul></section>
|
|
1277
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="validateSync" class="tsd-anchor"></a>
|
|
1278
|
+
<h3 class="tsd-anchor-link"><span>validate<wbr/>Sync</span><a href="#validateSync" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1279
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
|
|
1280
|
+
<li class="tsd-signature tsd-anchor-link" id="validateSync.validateSync-1">validate<wbr/>Sync<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span> </span>[k: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span><a href="#validateSync.validateSync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1281
|
+
<li class="tsd-description">
|
|
1282
|
+
<div class="tsd-comment tsd-typography"><p>Executes registered validation rules (skipping asynchronous validators) for this document.</p>
|
|
1283
|
+
</div>
|
|
1284
|
+
<div class="tsd-parameters">
|
|
1285
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1286
|
+
<ul class="tsd-parameter-list">
|
|
1287
|
+
<li>
|
|
1288
|
+
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>pathsToSkip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span><span class="tsd-signature-symbol">; </span><br/><span> </span>[k: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
1289
|
+
<ul class="tsd-parameters">
|
|
1290
|
+
<li class="tsd-parameter-index-signature">
|
|
1291
|
+
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li>
|
|
1292
|
+
<li class="tsd-parameter">
|
|
1293
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> paths<wbr/>To<wbr/>Skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">pathsToSkip</span></h5></li></ul></li></ul></div>
|
|
1294
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span></h4><aside class="tsd-sources">
|
|
1295
|
+
<p>Inherited from Document.validateSync</p>
|
|
1296
|
+
<ul>
|
|
1297
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-263">node_modules/mongoose/types/document.d.ts:263</a></li></ul></aside></li>
|
|
1298
|
+
<li class="tsd-signature tsd-anchor-link" id="validateSync.validateSync-2">validate<wbr/>Sync<span class="tsd-signature-symbol">(</span>pathsToValidate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PathsToValidate</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span><a href="#validateSync.validateSync-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
1299
|
+
<li class="tsd-description">
|
|
1300
|
+
<div class="tsd-parameters">
|
|
1301
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1302
|
+
<ul class="tsd-parameter-list">
|
|
1303
|
+
<li>
|
|
1304
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pathsToValidate: <span class="tsd-signature-type">PathsToValidate</span></h5></li>
|
|
1305
|
+
<li>
|
|
1306
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">AnyObject</span></h5></li></ul></div>
|
|
1307
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ValidationError</span></h4><aside class="tsd-sources">
|
|
1308
|
+
<p>Inherited from Document.validateSync</p>
|
|
1309
|
+
<ul>
|
|
1310
|
+
<li>Defined in <a href="https://bitbucket.org/bprtsk/ai-panel-core/src/e0603c5/node_modules/mongoose/types/document.d.ts#lines-264">node_modules/mongoose/types/document.d.ts:264</a></li></ul></aside></li></ul></section></section></div>
|
|
1311
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
1312
|
+
<div class="tsd-navigation settings">
|
|
1313
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1314
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
1315
|
+
<div class="tsd-accordion-details">
|
|
1316
|
+
<div class="tsd-filter-visibility">
|
|
1317
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1318
|
+
<ul id="tsd-filter-options">
|
|
1319
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
1320
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
1321
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
1322
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
1323
|
+
<div class="tsd-theme-toggle">
|
|
1324
|
+
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1325
|
+
<nav class="tsd-navigation primary">
|
|
1326
|
+
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
1327
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
1328
|
+
<div class="tsd-accordion-details">
|
|
1329
|
+
<ul>
|
|
1330
|
+
<li><a href="../modules.html">@bprotsyk/aso-<wbr/>core</a>
|
|
1331
|
+
<ul>
|
|
1332
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASOConfigFetch.html">ASOConfig<wbr/>Fetch</a></li>
|
|
1333
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v0.html">ASO_<wbr/>v0</a></li>
|
|
1334
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v1.html">ASO_<wbr/>v1</a></li>
|
|
1335
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v2.html">ASO_<wbr/>v2</a></li>
|
|
1336
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v3.html">ASO_<wbr/>v3</a></li>
|
|
1337
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v4.html">ASO_<wbr/>v4</a></li>
|
|
1338
|
+
<li class="tsd-kind-namespace"><a href="../modules/ASO_v5.html">ASO_<wbr/>v5</a></li></ul></li></ul></div></details></nav>
|
|
1339
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
1340
|
+
<ul>
|
|
1341
|
+
<li class="current tsd-kind-interface"><a href="IPanelUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>IPanel<wbr/>User</span></a>
|
|
1342
|
+
<ul>
|
|
1343
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_locals" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$locals</a></li>
|
|
1344
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_op" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$op</a></li>
|
|
1345
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_where" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>$where</a></li>
|
|
1346
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#__v" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>__v?</a></li>
|
|
1347
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_id" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>_id?</a></li>
|
|
1348
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#accessScopes" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>access<wbr/>Scopes</a></li>
|
|
1349
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#baseModelName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>base<wbr/>Model<wbr/>Name?</a></li>
|
|
1350
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#collection" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>collection</a></li>
|
|
1351
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#db" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>db</a></li>
|
|
1352
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#errors" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>errors?</a></li>
|
|
1353
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>id?</a></li>
|
|
1354
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isNew" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>is<wbr/>New</a></li>
|
|
1355
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#passwordHash" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>password<wbr/>Hash</a></li>
|
|
1356
|
+
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#schema" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>schema</a></li>
|
|
1357
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="IPanelUser.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>username</a></li>
|
|
1358
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_assertPopulated" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$assert<wbr/>Populated</a></li>
|
|
1359
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_clone" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$clone</a></li>
|
|
1360
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_getAllSubdocs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$get<wbr/>All<wbr/>Subdocs</a></li>
|
|
1361
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_getPopulatedDocs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$get<wbr/>Populated<wbr/>Docs</a></li>
|
|
1362
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_ignore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$ignore</a></li>
|
|
1363
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_inc" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$inc</a></li>
|
|
1364
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isDefault" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Default</a></li>
|
|
1365
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isDeleted" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Deleted</a></li>
|
|
1366
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isEmpty" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Empty</a></li>
|
|
1367
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_isValid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$is<wbr/>Valid</a></li>
|
|
1368
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_markValid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$mark<wbr/>Valid</a></li>
|
|
1369
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_model" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$model</a></li>
|
|
1370
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_parent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$parent</a></li>
|
|
1371
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_session" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$session</a></li>
|
|
1372
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#_set" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>$set</a></li>
|
|
1373
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#delete" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete</a></li>
|
|
1374
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#deleteOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>One</a></li>
|
|
1375
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#depopulate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>depopulate</a></li>
|
|
1376
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#directModifiedPaths" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>direct<wbr/>Modified<wbr/>Paths</a></li>
|
|
1377
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#equals" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>equals</a></li>
|
|
1378
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#get" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get</a></li>
|
|
1379
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#getChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Changes</a></li>
|
|
1380
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#increment" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>increment</a></li>
|
|
1381
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#init" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>init</a></li>
|
|
1382
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#invalidate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>invalidate</a></li>
|
|
1383
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isDirectModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Direct<wbr/>Modified</a></li>
|
|
1384
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isDirectSelected" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Direct<wbr/>Selected</a></li>
|
|
1385
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isInit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Init</a></li>
|
|
1386
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Modified</a></li>
|
|
1387
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#isSelected" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Selected</a></li>
|
|
1388
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#markModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>mark<wbr/>Modified</a></li>
|
|
1389
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#modifiedPaths" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>modified<wbr/>Paths</a></li>
|
|
1390
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#overwrite" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>overwrite</a></li>
|
|
1391
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#populate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>populate</a></li>
|
|
1392
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#populated" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>populated</a></li>
|
|
1393
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#remove" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove</a></li>
|
|
1394
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#replaceOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>replace<wbr/>One</a></li>
|
|
1395
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#save" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save</a></li>
|
|
1396
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set</a></li>
|
|
1397
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#toJSON" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>toJSON</a></li>
|
|
1398
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#toObject" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>Object</a></li>
|
|
1399
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#unmarkModified" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>unmark<wbr/>Modified</a></li>
|
|
1400
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#update" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update</a></li>
|
|
1401
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#updateOne" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>One</a></li>
|
|
1402
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#validate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate</a></li>
|
|
1403
|
+
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="IPanelUser.html#validateSync" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Sync</a></li></ul></li></ul></nav></div></div>
|
|
1404
|
+
<div class="container tsd-generator">
|
|
1405
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1406
1406
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|