@types/glob

What is @types/glob?

The @types/glob package provides TypeScript type definitions for the glob library, which is a utility that allows for pattern matching based on the rules used by the Unix shell. These type definitions enable TypeScript developers to use glob in a type-safe manner, ensuring that their usage of glob adheres to the expected types and interfaces.

What are @types/glob's main functionalities?

Pattern Matching

This feature allows you to match files in your filesystem using glob patterns. The example demonstrates how to find all TypeScript (.ts) files in a project and log them.

import * as glob from 'glob';

glob('**/*.ts', (err, files) => {
  if (err) {
    console.error('Glob pattern error', err);
    return;
  }
  console.log('Matched files:', files);
});

Synchronous Pattern Matching

This feature provides a way to synchronously find files matching a pattern. The code sample shows how to synchronously find and log all JavaScript (.js) files.

import * as glob from 'glob';

const files = glob.sync('**/*.js');
console.log('Matched JavaScript files:', files);

Using Options

This feature demonstrates how to use options to refine the search. In the example, the search is for all TypeScript files, excluding those in the node_modules directory.

import * as glob from 'glob';

glob('**/*.ts', { ignore: '**/node_modules/**' }, (err, files) => {
  if (err) {
    console.error('Glob pattern error', err);
    return;
  }
  console.log('Matched files:', files);
});

Other packages similar to @types/glob

minimatch

Minimatch is a minimal matching utility that implements the same glob pattern matching rules. It is actually used by glob under the hood. Compared to @types/glob, minimatch provides a more focused, lower-level interface for pattern matching without filesystem operations.

fast-glob

Fast-glob is an alternative to glob that focuses on performance and additional features like multiple pattern matching. It provides a similar API to glob but is designed to be faster and more efficient, especially for large sets of files.

node-glob

Node-glob is the underlying library that @types/glob provides types for. It offers the core functionality of file pattern matching. The comparison here is more about the relationship; @types/glob adds TypeScript support to node-glob, enhancing its usability in TypeScript projects.

README

Installation

npm install --save @types/glob

Summary

This package contains type definitions for glob (https://github.com/isaacs/node-glob).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glob.

Additional Details

• Last updated: Tue, 30 Aug 2022 19:32:38 GMT
• Dependencies: @types/minimatch, @types/node
• Global values: none

Credits

These definitions were written by vvakame, voy, Klaus Meinhardt, and Piotr Błażejewicz.