Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentFilter

A document filter denotes a document by different properties like the language, the scheme of its resource, or a glob-pattern that is applied to the path.

example
A language filter that applies to typescript files on disk { language: 'typescript', scheme: 'file' }
example
A language filter that applies to all package.json paths { language: 'json', pattern: '**​/package.json' }

Hierarchy

  • DocumentFilter

Index

Properties

Properties

Optional Readonly language

language: string

A language id, like typescript.

Optional Readonly scheme

scheme: string

A Uri scheme, like file or untitled.

Optional Readonly pattern

pattern: GlobPattern

A glob pattern that is matched on the absolute path of the document. Use a relative pattern to filter documents to a workspace folder.

Generated using TypeDoc