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.

sample

A language filter that applies to typescript files on disk: { language: 'typescript', scheme: 'file' }

sample

A language filter that applies to all package.json paths: { language: 'json', scheme: 'untitled', pattern: '**‚Äč/package.json' }

Hierarchy

  • DocumentFilter

Index

Properties

language?: string

A language id, like typescript.

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.

scheme?: string

A Uri scheme, like file or untitled.