Class Doer

A utility base class for the Parser and Generator classes providing a convenient interface to a filesystem folder and HTTP requests

Hierarchy

Doer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Doer(urlFetcher: UrlFetcher, folder: string | undefined): Doer

- Defined in src/Doer.ts:22
Parameters
- urlFetcher: UrlFetcher
- folder: string | undefined
Returns Doer

Properties

folder

folder: string

The directory to scan for relevant files

Protected Readonly urlFetcher

urlFetcher: UrlFetcher

The instance of IUrlFetcher to fetch URLs

Methods

exists

exists(subpath: string): boolean

- Defined in src/Doer.ts:35
Does a path exist within the project folder?

Parameters
- subpath: string
  
  The path within the folder
Returns boolean

fetch

fetch(url: string, options?: any): Promise<any>

- Defined in src/Doer.ts:83
Fetch content from a URL

Parameters
- url: string
  
  The URL to fetch
- Default value options: any = { responseType: 'json' }
  
  Request options
Returns Promise<any>

glob

glob(pattern: string | Array<string>): Array<string>

- Defined in src/Doer.ts:44
Get a list of paths that match a pattern in the project folder.

Parameters
- pattern: string | Array<string>
  
  The glob pattern
Returns Array<string>

read

read(subpath: string): string

- Defined in src/Doer.ts:63
Read a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
Returns string

write

write(subpath: string, content: string): void

- Defined in src/Doer.ts:73
Write to a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
- content: string
  
  The content to write to the file
Returns void

Generated using TypeDoc