A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
(language document-filter)
A language id, like typescript
.
Returns: string | undefined
A language id, like `typescript`. **Returns:** `string | undefined`
(notebook-type document-filter)
The {@link NotebookDocument.notebookType type} of a notebook, like jupyter-notebook
. This allows
to narrow down on the type of a notebook that a {@link NotebookCell.document cell document} belongs to.
Note that setting the notebookType
-property changes how scheme
and pattern
are interpreted. When set
they are evaluated against the {@link NotebookDocument.uri notebook uri}, not the document uri.
Returns: string | undefined
The {@link NotebookDocument.notebookType type} of a notebook, like `jupyter-notebook`. This allows to narrow down on the type of a notebook that a {@link NotebookCell.document cell document} belongs to. *Note* that setting the `notebookType`-property changes how `scheme` and `pattern` are interpreted. When set they are evaluated against the {@link NotebookDocument.uri notebook uri}, not the document uri. **Returns:** `string | undefined`
(pattern document-filter)
A {@link GlobPattern glob pattern} that is matched on the absolute path of the document. Use a {@link RelativePattern relative pattern} to filter documents to a {@link WorkspaceFolder workspace folder}.
Returns: GlobPattern | undefined
A {@link GlobPattern glob pattern} that is matched on the absolute path of the document. Use a {@link RelativePattern relative pattern} to filter documents to a {@link WorkspaceFolder workspace folder}. **Returns:** `GlobPattern | undefined`
(scheme document-filter)
A Uri {@link Uri.scheme scheme}, like file
or untitled
.
Returns: string | undefined
A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. **Returns:** `string | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close