feat: Initial clean release of CHM
一些检查失败了
automerge / automerge (push) Has been cancelled
react-native-android-build-apk / AssembleRelease (push) Has been cancelled
Build macOS M1 / Main (push) Has been cancelled
Joplin Continuous Integration / Main (macos-15-intel) (push) Has been cancelled
Joplin Continuous Integration / Main (ubuntu-22.04) (push) Has been cancelled
Joplin Continuous Integration / Main (ubuntu-22.04-arm) (push) Has been cancelled
Joplin Continuous Integration / Main (windows-11-vs2026-arm) (push) Has been cancelled
Joplin Continuous Integration / Main (windows-2025) (push) Has been cancelled
Joplin Continuous Integration / ServerDockerImage (ubuntu-22.04) (push) Has been cancelled
Joplin Continuous Integration / ServerDockerImage (ubuntu-22.04-arm) (push) Has been cancelled
Joplin UI tests / Main (ubuntu-22.04) (push) Has been cancelled
Joplin UI tests / Main (windows-2025) (push) Has been cancelled
Joplin UI tests / Mobile (push) Has been cancelled
Close stale issues / ProcessStaleIssues (push) Has been cancelled
一些检查失败了
automerge / automerge (push) Has been cancelled
react-native-android-build-apk / AssembleRelease (push) Has been cancelled
Build macOS M1 / Main (push) Has been cancelled
Joplin Continuous Integration / Main (macos-15-intel) (push) Has been cancelled
Joplin Continuous Integration / Main (ubuntu-22.04) (push) Has been cancelled
Joplin Continuous Integration / Main (ubuntu-22.04-arm) (push) Has been cancelled
Joplin Continuous Integration / Main (windows-11-vs2026-arm) (push) Has been cancelled
Joplin Continuous Integration / Main (windows-2025) (push) Has been cancelled
Joplin Continuous Integration / ServerDockerImage (ubuntu-22.04) (push) Has been cancelled
Joplin Continuous Integration / ServerDockerImage (ubuntu-22.04-arm) (push) Has been cancelled
Joplin UI tests / Main (ubuntu-22.04) (push) Has been cancelled
Joplin UI tests / Main (windows-2025) (push) Has been cancelled
Joplin UI tests / Mobile (push) Has been cancelled
Close stale issues / ProcessStaleIssues (push) Has been cancelled
这个提交包含在：
chen
文件差异内容过多而无法显示
加载差异
二进制文件未显示。
|
之后 宽度: | 高度: | 大小: 9.4 KiB |
二进制文件未显示。
|
之后 宽度: | 高度: | 大小: 28 KiB |
二进制文件未显示。
|
之后 宽度: | 高度: | 大小: 480 B |
二进制文件未显示。
|
之后 宽度: | 高度: | 大小: 855 B |
文件差异因一行或多行过长而隐藏
@@ -0,0 +1,38 @@
|
||||
function camelCaseToDots(s) {
|
||||
const output = [];
|
||||
for (let i = 0; i < s.length; i++) {
|
||||
const c = s[i];
|
||||
if (c === c.toLowerCase() || i === 0) {
|
||||
output.push(c.toLowerCase());
|
||||
} else {
|
||||
output.push('.');
|
||||
output.push(c.toLowerCase());
|
||||
}
|
||||
}
|
||||
|
||||
return output.join('');
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
jpFormatClassName: function(className) {
|
||||
if (className.indexOf('Joplin') !== 0 || className.indexOf(' ') >= 0) return className;
|
||||
|
||||
const p = className.substr(6);
|
||||
if (p === '') return 'joplin';
|
||||
|
||||
return `joplin.${camelCaseToDots(p)
|
||||
.replace(/menu\.items/, 'menuItems')
|
||||
.replace(/toolbar\.buttons/, 'toolbarButtons')
|
||||
.replace(/note\.list/, 'noteList')
|
||||
.replace(/content\.scripts/, 'contentScripts')}`;
|
||||
},
|
||||
|
||||
jpIsAllowedGroup: function(name) {
|
||||
return name !== 'Constructors';
|
||||
},
|
||||
|
||||
jsIsNotKindVariable: function(classes) {
|
||||
if (!classes) return true;
|
||||
return classes.indexOf('tsd-kind-variable') < 0;
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,3 @@
|
||||
# Joplin Plugin Documentation
|
||||
|
||||
Welcome to Joplin Plugin Documentation
|
||||
@@ -0,0 +1,51 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{jpFormatClassName model.name}} | {{project.name}}{{/ifCond}}</title>
|
||||
<meta name="description" content="Documentation for {{project.name}}">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
<link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
{{> header}}
|
||||
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
{{{contents}}}
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<!--
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
{{#each navigation.children}}
|
||||
{{> navigation}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
-->
|
||||
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
{{#each toc.children}}
|
||||
{{> toc.root}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{> footer}}
|
||||
|
||||
<div class="overlay"></div>
|
||||
<script src="{{relativeURL "assets/js/main.js"}}"></script>
|
||||
|
||||
{{> analytics}}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,11 @@
|
||||
{{#if settings.gaID}}
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', '{{settings.gaID}}', '{{settings.gaSite}}');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
{{/if}}
|
||||
@@ -0,0 +1,18 @@
|
||||
{{#if parent}}
|
||||
{{#with parent}}{{> breadcrumb}}{{/with}}
|
||||
<li>
|
||||
{{#if url}}
|
||||
<a href="{{relativeURL url}}">{{jpFormatClassName name}}</a>
|
||||
{{else}}
|
||||
<span>{{jpFormatClassName name}}</span>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{else}}
|
||||
<!--
|
||||
{{#if url}}
|
||||
<li>
|
||||
<a href="{{relativeURL url}}">Globals</a>
|
||||
</li>
|
||||
{{/if}}
|
||||
-->
|
||||
{{/if}}
|
||||
@@ -0,0 +1,22 @@
|
||||
{{#with comment}}
|
||||
{{#if hasVisibleComponent}}
|
||||
<div class="tsd-comment tsd-typography">
|
||||
{{#if shortText}}
|
||||
<div class="lead">
|
||||
{{#markdown}}{{{shortText}}}{{/markdown}}
|
||||
</div>
|
||||
{{/if}}
|
||||
{{#if text}}
|
||||
{{#markdown}}{{{text}}}{{/markdown}}
|
||||
{{/if}}
|
||||
{{#if tags}}
|
||||
<dl class="tsd-comment-tags">
|
||||
{{#each tags}}
|
||||
<dt>{{tagName}}</dt>
|
||||
<dd>{{#markdown}}{{{text}}}{{/markdown}}</dd>
|
||||
{{/each}}
|
||||
</dl>
|
||||
{{/if}}
|
||||
</div>
|
||||
{{/if}}
|
||||
{{/with}}
|
||||
@@ -0,0 +1,23 @@
|
||||
|
||||
<!-- JOPLINCHANGE
|
||||
<footer{{#unless settings.hideGenerator}} class="with-border-bottom"{{/unless}}>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
{{#each legend}}
|
||||
<ul class="tsd-legend">
|
||||
{{#each .}}
|
||||
<li class="{{#compact}}{{#each classes}} {{.}}{{/each}}{{/compact}}"><span class="tsd-kind-icon">{{name}}</span></li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/each}}
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
{{#unless settings.hideGenerator}}
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
{{/unless}}
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.json"}}" data-base="{{relativeURL "./"}}">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
|
||||
<a href="{{relativeURL "classes/joplin.html"}}" class="title">{{project.name}}</a>
|
||||
</div>
|
||||
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
|
||||
{{#unless settings.excludeExternals}}
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
{{/unless}}
|
||||
|
||||
{{#unless settings.excludeNotExported}}
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
{{/unless}}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
{{#with model}}{{> breadcrumb}}{{/with}}
|
||||
</ul>
|
||||
<h1>{{#compact}}
|
||||
<!-- {{model.kindString}} -->
|
||||
{{jpFormatClassName model.name}}
|
||||
{{#if model.typeParameters}}
|
||||
<
|
||||
{{#each model.typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
{{/compact}}</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
@@ -0,0 +1,17 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
{{#each types}}
|
||||
<li>
|
||||
{{#if ../isTarget}}
|
||||
<span class="target">{{this}}</span>
|
||||
{{else}}
|
||||
{{#compact}}{{> type}}{{/compact}}
|
||||
{{/if}}
|
||||
|
||||
{{#if @last}}
|
||||
{{#with ../next}}
|
||||
{{> hierarchy}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
@@ -0,0 +1,32 @@
|
||||
{{#if groups}}
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
{{#each groups}}
|
||||
<section class="tsd-index-section {{cssClasses}}">
|
||||
{{#if categories}}
|
||||
{{#each categories}}
|
||||
<h3>{{#if title}}{{title}} {{/if}}{{../title}}</h3>
|
||||
<ul class="tsd-index-list">
|
||||
{{#each children}}
|
||||
<li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/each}}
|
||||
{{else}}
|
||||
{{#if (jpIsAllowedGroup title)}}
|
||||
<h3>{{title}}</h3>
|
||||
<ul class="tsd-index-list">
|
||||
{{#each children}}
|
||||
<li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</section>
|
||||
{{/each}}
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
{{/if}}
|
||||
@@ -0,0 +1,36 @@
|
||||
<div class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
{{{wbr name}}}
|
||||
{{#if typeParameters}}
|
||||
<
|
||||
{{#each typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
<span class="tsd-signature-symbol">{{#if isOptional}}?{{/if}}:</span> {{#with type}}{{>type}}{{/with}}
|
||||
{{#if defaultValue}}
|
||||
<span class="tsd-signature-symbol">
|
||||
=
|
||||
{{defaultValue}}
|
||||
</span>
|
||||
{{/if}}
|
||||
{{/compact}}</div>
|
||||
|
||||
{{> member.sources}}
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if typeParameters}}
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
{{> typeParameters}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
</div>
|
||||
{{/if}}
|
||||
@@ -0,0 +1,37 @@
|
||||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#if getSignature}}
|
||||
{{#with getSignature}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">get</span>
|
||||
{{../name}}
|
||||
{{> member.signature.title hideName=true }}
|
||||
{{/compact}}</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{#if setSignature}}
|
||||
{{#with setSignature}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">set</span>
|
||||
{{../name}}
|
||||
{{> member.signature.title hideName=true }}
|
||||
{{/compact}}</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#if getSignature}}
|
||||
{{#with getSignature}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{#if setSignature}}
|
||||
{{#with setSignature}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</ul>
|
||||
@@ -0,0 +1,24 @@
|
||||
<section class="tsd-panel tsd-member {{cssClasses}}">
|
||||
<a name="{{anchor}}" class="tsd-anchor"></a>
|
||||
{{#if name}}
|
||||
<h3>{{#each flags}}<span class="tsd-flag ts-flag{{this}}">{{this}}</span> {{/each}}{{{wbr name}}}</h3>
|
||||
{{/if}}
|
||||
|
||||
{{#if signatures}}
|
||||
{{> member.signatures}}
|
||||
{{else}}{{#if hasGetterOrSetter}}
|
||||
{{> member.getterSetter}}
|
||||
{{else}}{{#if isReference}}
|
||||
{{> member.reference}}
|
||||
{{else}}
|
||||
{{> member.declaration}}
|
||||
{{/if}}{{/if}}{{/if}}
|
||||
|
||||
{{#each groups}}
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
{{/each}}
|
||||
</section>
|
||||
@@ -0,0 +1,11 @@
|
||||
{{#with tryGetTargetReflectionDeep}}
|
||||
{{#ifCond ../name '===' name}}
|
||||
Re-exports <a href="{{relativeURL url}}">{{name}}</a>
|
||||
{{else if flags.isExported}}
|
||||
Renames and re-exports <a href="{{relativeURL url}}">{{name}}</a>
|
||||
{{else}}
|
||||
Renames and exports <a href="{{relativeURL url}}">{{name}}</a>
|
||||
{{/ifCond}}
|
||||
{{else}}
|
||||
Re-exports {{name}}
|
||||
{{/with}}
|
||||
@@ -0,0 +1,58 @@
|
||||
{{#unless hideSources}}
|
||||
{{> member.sources}}
|
||||
{{/unless}}
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if typeParameters}}
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
{{> typeParameters}}
|
||||
{{/if}}
|
||||
|
||||
{{#if parameters}}
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
{{#each parameters}}
|
||||
<li>
|
||||
<h5>{{#compact}}
|
||||
{{#each flags}}
|
||||
<span class="tsd-flag ts-flag{{this}}">{{this}}</span>
|
||||
{{/each}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{name}}:
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{#if defaultValue}}
|
||||
<span class="tsd-signature-symbol">
|
||||
=
|
||||
{{defaultValue}}
|
||||
</span>
|
||||
{{/if}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
|
||||
<!-- JOPLINCHANGE
|
||||
{{#if type}}
|
||||
<h4 class="tsd-returns-title">Returns {{#compact}}{{#with type}}{{>type}}{{/with}}{{/compact}}</h4>
|
||||
|
||||
{{#if comment.returns}}
|
||||
{{#markdown}}{{{comment.returns}}}{{/markdown}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
-->
|
||||
@@ -0,0 +1,32 @@
|
||||
{{#unless hideName}}{{{wbr name}}}{{/unless}}
|
||||
{{#if typeParameters}}
|
||||
<
|
||||
{{#each typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{#each parameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{name}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if flags.isOptional}}?{{/if}}
|
||||
{{#if defaultValue}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{#if type}}
|
||||
{{#if arrowStyle}}
|
||||
<span class="tsd-signature-symbol"> => </span>
|
||||
{{else}}
|
||||
<span class="tsd-signature-symbol">: </span>
|
||||
{{/if}}
|
||||
{{#with type}}
|
||||
{{>type}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
@@ -0,0 +1,13 @@
|
||||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}{{> member.signature.title }}{{/compact}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
@@ -0,0 +1,11 @@
|
||||
<aside class="tsd-sources">
|
||||
{{#if implementationOf}}
|
||||
<p>Implementation of {{#with implementationOf}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
{{#if inheritedFrom}}
|
||||
<p>Inherited from {{#with inheritedFrom}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
{{#if overwrites}}
|
||||
<p>Overrides {{#with overwrites}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
</aside>
|
||||
@@ -0,0 +1,23 @@
|
||||
{{#if categories}}
|
||||
{{#each categories}}
|
||||
<section class="tsd-panel-group tsd-member-group {{cssClasses}}">
|
||||
<h2>{{#if title}}{{title}} {{/if}}{{../title}}</h2>
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
</section>
|
||||
{{/each}}
|
||||
{{else}}
|
||||
<section class="tsd-panel-group tsd-member-group {{cssClasses}}">
|
||||
{{#if (jpIsAllowedGroup title)}}
|
||||
<h2>{{title}}</h2>
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
</section>
|
||||
{{/if}}
|
||||
@@ -0,0 +1,20 @@
|
||||
{{#if categories}}
|
||||
{{#each categories}}
|
||||
{{#unless allChildrenHaveOwnDocument}}
|
||||
<section class="tsd-panel-group tsd-member-group {{cssClasses}}">
|
||||
<h2>{{title}}</h2>
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
</section>
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
{{else}}
|
||||
{{#each groups}}
|
||||
{{#unless allChildrenHaveOwnDocument}}
|
||||
{{> members.group}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
@@ -0,0 +1,26 @@
|
||||
{{#if isVisible}}
|
||||
{{#if isLabel}}
|
||||
<li class="label {{cssClasses}}">
|
||||
<span>{{{wbr title}}}</span>
|
||||
</li>
|
||||
{{else}}
|
||||
{{#if isGlobals}}
|
||||
<li class="globals {{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}"><em>{{{wbr title}}}</em></a>
|
||||
</li>
|
||||
{{else}}
|
||||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}">{{{wbr title}}}</a>
|
||||
{{#if isInPath}}
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> navigation}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
@@ -0,0 +1,83 @@
|
||||
<ul class="tsd-parameters">
|
||||
{{#if signatures}}
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
{{> member.signature.title hideName=true }}
|
||||
{{/compact}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-description">{{> member.signature.body hideSources=true }}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</li>
|
||||
{{/if}}
|
||||
{{#if indexSignature}}
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5>{{#compact}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#each indexSignature.parameters}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}{{name}}: {{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">]: </span>
|
||||
{{#with indexSignature.type}}{{>type}}{{/with}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{#with indexSignature}}
|
||||
{{> comment}}
|
||||
{{/with}}
|
||||
|
||||
{{#if indexSignature.type.declaration}}
|
||||
{{#with indexSignature.type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/if}}
|
||||
{{#each children}}
|
||||
<li class="tsd-parameter">
|
||||
{{#if signatures}}
|
||||
<h5>{{#compact}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{{wbr name}}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if isOptional}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
function
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> member.signatures}}
|
||||
{{else}}
|
||||
<h5>{{#compact}}
|
||||
{{#each flags}}
|
||||
<span class="tsd-flag ts-flag{{this}}">{{this}}</span>
|
||||
{{/each}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{{wbr name}}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if flags.isOptional}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if children}}
|
||||
{{> parameter}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
@@ -0,0 +1,10 @@
|
||||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}" class="tsd-kind-icon">{{{wbr title}}}</a>
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> toc}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
@@ -0,0 +1,21 @@
|
||||
{{#if isInPath}}
|
||||
</ul>
|
||||
<ul class="current">
|
||||
{{/if}}
|
||||
|
||||
{{#if (jsIsNotKindVariable cssClasses)}}
|
||||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}" class="tsd-kind-icon">{{{jpFormatClassName title}}}</a>
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> toc}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{#if isInPath}}
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
@@ -0,0 +1,211 @@
|
||||
{{! Each type gets its own inline helper to determine how it is rendered. }}
|
||||
{{! The name of the helper is the value of the 'type' property on the type.}}
|
||||
|
||||
{{!
|
||||
The type helper accepts an optional needsParens parameter that is checked
|
||||
if an inner type may result in invalid output without them. For example:
|
||||
1 | 2[] !== (1 | 2)[]
|
||||
() => 1 | 2 !== (() => 1) | 2
|
||||
}}
|
||||
|
||||
{{#*inline 'array'}}
|
||||
{{#with elementType}}
|
||||
{{> type needsParens=true}}
|
||||
<span class="tsd-signature-symbol">[]</span>
|
||||
{{/with}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'conditional'}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{/if}}
|
||||
{{#with checkType}}
|
||||
{{> type needsParens=true}}
|
||||
{{/with}}
|
||||
<span class="tsd-signature-symbol"> extends </span>
|
||||
{{#with extendsType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
<span class="tsd-signature-symbol"> ? </span>
|
||||
{{#with trueType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
<span class="tsd-signature-symbol"> : </span>
|
||||
{{#with falseType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'indexedAccess'}}
|
||||
{{#with objectType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#with indexType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
<span class="tsd-signature-symbol">]</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'inferred'}}
|
||||
<span class="tsd-signature-symbol">infer </span> {{name}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'intersection'}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{/if}}
|
||||
{{#each types}}
|
||||
{{#unless @first}}
|
||||
<span class="tsd-signature-symbol"> & </span>
|
||||
{{/unless}}
|
||||
{{> type}}
|
||||
{{/each}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'intrinsic'}}
|
||||
<span class="tsd-signature-type">{{name}}</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'predicate'}}
|
||||
{{#if asserts}}
|
||||
<span class="tsd-signature-symbol">asserts</span>
|
||||
{{/if}}
|
||||
<span class="tsd-signature-type">{{name}}</span>
|
||||
{{#if targetType}}
|
||||
<span class="tsd-signature-symbol"> is </span>
|
||||
{{#with targetType}}
|
||||
{{>type}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'query'}}
|
||||
<span class="tsd-signature-symbol">typeof </span>
|
||||
{{#with queryType}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'reference'}}
|
||||
{{#if reflection}}
|
||||
<a href="{{relativeURL reflection.url}}" class="tsd-signature-type">
|
||||
{{jpFormatClassName reflection.name}}
|
||||
</a>
|
||||
{{else}}
|
||||
<span class="tsd-signature-type">{{jpFormatClassName name}}</span>
|
||||
{{/if}}
|
||||
{{#if typeArguments}}
|
||||
<span class="tsd-signature-symbol"><</span>
|
||||
{{#each typeArguments}}
|
||||
{{#unless @first}}
|
||||
<span class="tsd-signature-symbol">, </span>
|
||||
{{/unless}}
|
||||
{{> type}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">></span>
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'reflection'}}
|
||||
{{#if declaration.children}} {{! object literal }}
|
||||
<span class="tsd-signature-symbol">{ </span>
|
||||
{{#each declaration.children}}
|
||||
{{#unless @first}}
|
||||
<span class="tsd-signature-symbol">; </span>
|
||||
{{/unless}}
|
||||
{{name}}
|
||||
{{#if flags.isOptional }}
|
||||
<span class="tsd-signature-symbol">?: </span>
|
||||
{{else}}
|
||||
<span class="tsd-signature-symbol">: </span>
|
||||
{{/if}}
|
||||
{{#with type}}
|
||||
{{> type}}
|
||||
{{else}}
|
||||
<span class="tsd-signature-type">any</span>
|
||||
{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol"> }</span>
|
||||
{{else if declaration.signatures}}
|
||||
{{#if (lookup declaration.signatures 1) }} {{! more than one signature}}
|
||||
<span class="tsd-signature-symbol">{ </span>
|
||||
{{#each declaration.signatures}}
|
||||
{{> member.signature.title hideName=true}}
|
||||
{{#unless @last}}
|
||||
<span class="tsd-signature-symbol">; </span>
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol"> }</span>
|
||||
{{else}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{/if}}
|
||||
{{#with (lookup declaration.signatures '0') }}
|
||||
{{> member.signature.title hideName=true arrowStyle=true}}
|
||||
{{/with}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
<span class="tsd-signature-symbol">{}</span>
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'stringLiteral'}}
|
||||
<span class="tsd-signature-type">"{{value}}"</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'tuple'}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#each elements}}
|
||||
{{#unless @first}}
|
||||
<span class="tsd-signature-symbol">, </span>
|
||||
{{/unless}}
|
||||
{{> type}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">]</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'typeOperator'}}
|
||||
<span class="tsd-signature-symbol">{{operator}} </span>
|
||||
{{#with target}}
|
||||
{{> type}}
|
||||
{{/with}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'typeParameter'}}
|
||||
<span class="tsd-signature-type">{{name}}</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'union'}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{/if}}
|
||||
{{#each types}}
|
||||
{{#unless @first}}
|
||||
<span class="tsd-signature-symbol"> | </span>
|
||||
{{/unless}}
|
||||
{{> type needsParens=true}}
|
||||
{{/each}}
|
||||
{{#if needsParens}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{/if}}
|
||||
{{/inline}}
|
||||
|
||||
{{#*inline 'unknown'}}
|
||||
<span class="tsd-signature-type">{{name}}</span>
|
||||
{{/inline}}
|
||||
|
||||
{{#if this}}
|
||||
{{> (lookup . 'type') }}
|
||||
{{else}}
|
||||
<span class="tsd-signature-type">void</span>
|
||||
{{/if}}
|
||||
@@ -0,0 +1,42 @@
|
||||
{{#compact}}
|
||||
{{#if this}}
|
||||
{{#if elementType}}
|
||||
{{#with elementType}}
|
||||
{{> typeAndParent}}
|
||||
{{/with}}
|
||||
[]
|
||||
{{else}}
|
||||
{{#if reflection}}
|
||||
{{#ifSignature reflection}}
|
||||
{{#if reflection.parent.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.parent.url}}">{{reflection.parent.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.parent.name}}
|
||||
{{/if}}
|
||||
.
|
||||
{{#if reflection.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.name}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
{{#if reflection.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.name}}
|
||||
{{/if}}
|
||||
.
|
||||
{{#if reflection.url}}
|
||||
<a href="{{relativeURL reflection.url}}">{{reflection.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.name}}
|
||||
{{/if}}
|
||||
{{/ifSignature}}
|
||||
{{else}}
|
||||
{{this}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
void
|
||||
{{/if}}
|
||||
{{/compact}}
|
||||
@@ -0,0 +1,14 @@
|
||||
<ul class="tsd-type-parameters">
|
||||
{{#each typeParameters}}
|
||||
<li>
|
||||
<h4>{{#compact}}
|
||||
{{name}}
|
||||
{{#if type}}
|
||||
<span class="tsd-signature-symbol">: </span>
|
||||
{{#with type}}{{> type}}{{/with}}
|
||||
{{/if}}
|
||||
{{/compact}}</h4>
|
||||
{{> comment}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
@@ -0,0 +1,3 @@
|
||||
<div class="tsd-panel tsd-typography">
|
||||
{{#markdown}}{{{model.readme}}}{{/markdown}}
|
||||
</div>
|
||||
@@ -0,0 +1,81 @@
|
||||
{{#with model}}
|
||||
{{#if hasComment}}
|
||||
<section class="tsd-panel tsd-comment">
|
||||
{{> comment}}
|
||||
</section>
|
||||
{{/if}}
|
||||
{{/with}}
|
||||
|
||||
{{#if model.typeParameters}}
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h3>Type parameters</h3>
|
||||
{{#with model}}{{> typeParameters}}{{/with}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.typeHierarchy}}
|
||||
<!--
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
{{#with model.typeHierarchy}}{{> hierarchy}}{{/with}}
|
||||
</section>
|
||||
-->
|
||||
{{/if}}
|
||||
|
||||
{{#if model.implementedTypes}}
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
{{#each model.implementedTypes}}
|
||||
<li>{{#compact}}{{> type}}{{/compact}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.implementedBy}}
|
||||
<section class="tsd-panel">
|
||||
<h3>Implemented by</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
{{#each model.implementedBy}}
|
||||
<li>{{#compact}}{{> type}}{{/compact}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.signatures}}
|
||||
<section class="tsd-panel">
|
||||
<h3 class="tsd-before-signature">Callable</h3>
|
||||
{{#with model}}{{> member.signatures}}{{/with}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.indexSignature}}
|
||||
<section class="tsd-panel {{model.cssClasses}}">
|
||||
<h3 class="tsd-before-signature">Indexable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#each model.indexSignature.parameters}}
|
||||
{{name}}: {{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">]: </span>
|
||||
{{#with model.indexSignature.type}}{{>type}}{{/with}}
|
||||
{{/compact}}</div>
|
||||
|
||||
{{#with model.indexSignature}}
|
||||
{{> comment}}
|
||||
{{/with}}
|
||||
|
||||
{{#if model.indexSignature.type.declaration}}
|
||||
{{#with model.indexSignature.type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#with model}}
|
||||
{{> index}}
|
||||
{{> members}}
|
||||
{{/with}}
|
||||
在新工单中引用
屏蔽一个用户