tinyglobby documentation v0.2.15

function glob(patterns: string | readonly string[], options?: Omit<GlobOptions, "patterns">): Promise<string[]> (+1 overload)
Asynchronously match files following a glob pattern.
@see{@link https://superchupu.dev/tinyglobby/documentation#glob}glob

Asynchronously match files following a glob pattern.

import { glob } from 'tinyglobby';

const files = await glob('src/**', {
  cwd: './projects/best-cats'
});

function globSync(patterns: string | readonly string[], options?: Omit<GlobOptions, "patterns">): string[] (+1 overload)
Synchronously match files following a glob pattern.
@see{@link https://superchupu.dev/tinyglobby/documentation#globSync}globSync

Synchronously match files following a glob pattern.

import { globSync } from 'tinyglobby';

const files = globSync('src/**', {
  cwd: './projects/best-cats'
});

const convertPathToPattern: (path: string) => string
Converts a path to a pattern depending on the platform.
Identical to 
{@link 
escapePath
}
 on POSIX systems.
@see{@link https://superchupu.dev/tinyglobby/documentation#convertPathToPattern}convertPathToPattern

Converts a path to a pattern depending on the platform. Identical to escapePath on POSIX systems.

import { convertPathToPattern } from 'tinyglobby';

convertPathToPattern('[413] home stuck funny moments*.mp4');
// Returns "\[413\] home stuck funny moments\*.mp4"

const escapePath: (path: string) => string
Escapes a path's special characters depending on the platform.
@see{@link https://superchupu.dev/tinyglobby/documentation#escapePath}escapePath

Escapes a path's special characters depending on the platform.

import { escapePath } from 'tinyglobby';

escapePath('i use linux and i can use \\ in filenames!!()!');
// Returns "i use linux and i can use \\ in filenames!\!\(\)!"

function isDynamicPattern(pattern: string, options?: {
    caseSensitiveMatch: boolean;
}): boolean
Checks if a pattern has dynamic parts.

Has a few minor differences with [`fast-glob`](https://github.com/mrmlnc/fast-glob) for better accuracy:

- Doesn't necessarily return `false` on patterns that include `\`.
- Returns `true` if the pattern includes parentheses, regardless of them representing one single pattern or not.
- Returns `true` for unfinished glob extensions i.e. `(h`, `+(h`.
- Returns `true` for unfinished brace expansions as long as they include `,` or `..`.
@see{@link https://superchupu.dev/tinyglobby/documentation#isDynamicPattern}isDynamicPattern

Checks if a pattern has dynamic parts.

Has a few minor differences with fast-glob for better accuracy:

• Doesn't necessarily return false on patterns that include "\\".
• Returns true if the pattern includes parentheses, regardless of them representing one single pattern or not.
• Returns true for unfinished glob extensions i.e. "(h", "+(h".
• Returns true for unfinished brace expansions as long as they include "," or "..".

import { isDynamicPattern } from 'tinyglobby';

isDynamicPattern('my-dream.txt');
// ^ false

isDynamicPattern('star.*');
// ^ true

const absolute: boolean | undefinedabsolute

Whether to return absolute paths. Disable to have relative paths.

const braceExpansion: boolean | undefinedbraceExpansion

Enables support for brace expansion syntax, like "{a,b}" or "{1..9}".

const caseSensitiveMatch: boolean | undefinedcaseSensitiveMatch

Whether to match in case-sensitive mode.

const cwd: string | URL | undefinedcwd

The working directory in which to search. Results will be returned relative to this directory, unless absolute is set.

It is important to avoid globbing outside this directory when possible, even with absolute paths enabled, as doing so can harm performance due to having to recalculate relative paths.

import { glob } from 'tinyglobby';

// Avoid this - will calculate it relative to `process.cwd()`!
await glob(`${searchDir}/*.ts`, {
  absolute: true
});

// Do this instead:
await glob(`${searchDir}/*.ts`, {
  absolute: true,
  cwd: searchDir
});

const debug: boolean | undefineddebug

Logs useful debug information. Meant for development purposes. Logs can change at any time.

const deep: number | undefineddeep

Maximum directory depth to crawl.

const dot: boolean | undefineddot

Whether to return entries that start with a dot, like .gitignore or .prettierrc.

const expandDirectories: boolean | undefinedexpandDirectories

Whether to automatically expand directory patterns. Important to disable if migrating from fast-glob.

const extglob: boolean | undefinedextglob

Enables support for extglobs, like "+(pattern)".

const followSymbolicLinks: boolean | undefinedfollowSymbolicLinks

Whether to traverse and include symbolic links. Can slightly affect performance.

const fs: Partial<FSLike> | undefinedfs

An object that overrides node:fs functions.

type FileSystemAdapter = {
  readdir?: typeof fs.readdir;
  readdirSync?: typeof fs.readdirSync;
  realpath?: typeof fs.realpath;
  realpathSync?: typeof fs.realpathSync;
  stat?: typeof fs.stat;
  statSync?: typeof fs.statSync;
};

const globstar: boolean | undefinedglobstar

Enables support for matching nested directories with globstars ("**"). If false, "**" behaves exactly like "*".

const ignore: string | readonly string[] | undefinedignore

Glob patterns to exclude from the results.

const onlyDirectories: boolean | undefinedonlyDirectories

Enable to only return directories. If true, disables onlyFiles.

const onlyFiles: boolean | undefinedonlyFiles

Enable to only return files.

const signal: AbortSignal | undefinedsignal

An AbortSignal to abort crawling the file system.

import { glob } from 'tinyglobby';

// Stops crawling if taking too long
await glob('**', {
  signal: AbortSignal.timeout(1000)
});