index.d.ts 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. import type { GlobOptions, GlobOptionsWithFileTypesFalse, GlobOptionsWithFileTypesTrue, GlobOptionsWithFileTypesUnset, Results } from './glob.js';
  2. import { Glob } from './glob.js';
  3. import type { GWOFileTypesFalse, GWOFileTypesTrue, GWOFileTypesUnset, MatchStream, Result } from './walker.js';
  4. /**
  5. * Syncronous form of {@link globStream}. Will read all the matches as fast as
  6. * you consume them, even all in a single tick if you consume them immediately,
  7. * but will still respond to backpressure if they're not consumed immediately.
  8. */
  9. export declare function globStreamSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): MatchStream<GWOFileTypesTrue>;
  10. export declare function globStreamSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): MatchStream<GWOFileTypesFalse>;
  11. export declare function globStreamSync(pattern: string | string[], options: GlobOptionsWithFileTypesUnset): MatchStream<GWOFileTypesUnset>;
  12. export declare function globStreamSync(pattern: string | string[], options: GlobOptions): MatchStream<GlobOptions>;
  13. /**
  14. * Return a stream that emits all the strings or `Path` objects and
  15. * then emits `end` when completed.
  16. */
  17. export declare function globStream(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): MatchStream<GWOFileTypesFalse>;
  18. export declare function globStream(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): MatchStream<GWOFileTypesTrue>;
  19. export declare function globStream(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): MatchStream<GWOFileTypesUnset>;
  20. export declare function globStream(pattern: string | string[], options: GlobOptions): MatchStream<GlobOptions>;
  21. /**
  22. * Synchronous form of {@link glob}
  23. */
  24. export declare function globSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Results<GWOFileTypesFalse>;
  25. export declare function globSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Results<GWOFileTypesTrue>;
  26. export declare function globSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Results<GWOFileTypesUnset>;
  27. export declare function globSync(pattern: string | string[], options: GlobOptions): Results<GlobOptions>;
  28. /**
  29. * Perform an asynchronous glob search for the pattern(s) specified. Returns
  30. * [Path](https://isaacs.github.io/path-scurry/classes/PathBase) objects if the
  31. * {@link withFileTypes} option is set to `true`. See {@link GlobOptions} for
  32. * full option descriptions.
  33. */
  34. export declare function glob(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Promise<Results<GWOFileTypesUnset>>;
  35. export declare function glob(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Promise<Results<GWOFileTypesTrue>>;
  36. export declare function glob(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Promise<Results<GWOFileTypesFalse>>;
  37. export declare function glob(pattern: string | string[], options: GlobOptions): Promise<Results<GlobOptions>>;
  38. /**
  39. * Return an async iterator for walking glob pattern matches.
  40. */
  41. export declare function globIterate(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): AsyncGenerator<Result<GWOFileTypesUnset>, void, void>;
  42. export declare function globIterate(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): AsyncGenerator<Result<GWOFileTypesTrue>, void, void>;
  43. export declare function globIterate(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): AsyncGenerator<Result<GWOFileTypesFalse>, void, void>;
  44. export declare function globIterate(pattern: string | string[], options: GlobOptions): AsyncGenerator<Result<GlobOptions>, void, void>;
  45. /**
  46. * Return a sync iterator for walking glob pattern matches.
  47. */
  48. export declare function globIterateSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Generator<Result<GWOFileTypesUnset>, void, void>;
  49. export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Result<GWOFileTypesTrue>, void, void>;
  50. export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<Result<GWOFileTypesFalse>, void, void>;
  51. export declare function globIterateSync(pattern: string | string[], options: GlobOptions): Generator<Result<GlobOptions>, void, void>;
  52. export { Glob } from './glob.js';
  53. export type { GlobOptions, GlobOptionsWithFileTypesFalse, GlobOptionsWithFileTypesTrue, GlobOptionsWithFileTypesUnset, Result, Results, } from './glob.js';
  54. export { hasMagic } from './has-magic.js';
  55. export type { MatchStream } from './walker.js';
  56. declare const _default: typeof glob & {
  57. glob: typeof glob;
  58. globSync: typeof globSync;
  59. globStream: typeof globStream;
  60. globStreamSync: typeof globStreamSync;
  61. globIterate: typeof globIterate;
  62. globIterateSync: typeof globIterateSync;
  63. Glob: typeof Glob;
  64. hasMagic: (pattern: string | string[], options?: GlobOptions) => boolean;
  65. };
  66. export default _default;