Class DocometReplacer

Replacer

See

Hierarchy (View Summary)

DocometInspectableObjectClass
- DocometReplacer

Index

Constructors

Accessors

Methods

replaceFileAsync replaceStringAsync

Constructors

constructor

new DocometReplacer(value?: any): DocometReplacer
Parameters
- Optionalvalue: any
Returns DocometReplacer
Inherited from DocometInspectableObjectClass.constructor
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:156

Accessors

`Static`operationNames

get operationNames(): string[]
Operation names

Returns string[]
- Defined in src/internal/replace/docomet-replacer.ts:34

Methods

`Static`replaceFileAsync

replaceFileAsync(
    filePath: string,
    logging?: DocometLogging,
    encoding?: BufferEncoding,
): Promise<void>
Replace files
Parameters
- filePath: string
  File path
- logging: DocometLogging = console.error
  DocometLogging function
- encoding: BufferEncoding = DocometEncoding.UTF8
  File encoding
Returns Promise<void>
- Defined in src/internal/replace/docomet-replacer.ts:113

`Static`replaceStringAsync

replaceStringAsync(target: string): Promise<string>
Replace strings
Parameters
- target: string
  Target string
Returns Promise<string>
Modified string
- Defined in src/internal/replace/docomet-replacer.ts:103