Global - Documentation

Methods

append(line)

Appends a given line to a file

Parameters:

Name	Type	Description
`line`	string

Source:

bufferedEditor.js, line 69

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .append(line)
 .save();

append(line)

Appends a given line to a file

Parameters:

Name	Type	Description
`line`	string

Source:

streamEditor.js, line 119

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .append(line)
 .save();

delete(fn)

Deletes line by line number

Parameters:

Name	Type	Description
`fn`	function

Source:

streamEditor.js, line 204

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .delete(10)
 .save(); // delete line 10

delete(fn)

Deletes line by line number

Parameters:

Name	Type	Description
`fn`	function

Source:

bufferedEditor.js, line 153

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .delete(10)
 .save(); // delete line 10

filter(fn)

Filters the file contents using a given function

Parameters:

Name	Type	Description
`fn`	function

Source:

bufferedEditor.js, line 132

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .filter((line) => {
     return line.length < 10;
 })
 .save();

filter(fn)

Filters the file contents using a given function

Parameters:

Name	Type	Description
`fn`	function

Source:

streamEditor.js, line 182

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .filter((line) => {
     return line.length < 10;
 })
 .save();

map(fn)

Maps each line using a given function

Parameters:

Name	Type	Description
`fn`	function

Source:

bufferedEditor.js, line 111

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .map((line) => {
     return line.toLowerCase() < 10;
 })
 .save();

map(fn)

Maps each line using a given function

Parameters:

Name	Type	Description
`fn`	function

Source:

streamEditor.js, line 161

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .map((line) => {
     return line.toLowerCase() < 10;
 })
 .save();

prepend(line)

Prepends a given line to a file

Parameters:

Name	Type	Description
`line`	string

Source:

bufferedEditor.js, line 50

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .prepend(line)
 .save();

prepend(line)

Prepends a given line to a file

Parameters:

Name	Type	Description
`line`	string

Source:

streamEditor.js, line 98

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .prepend(line)
 .save();

preview()

Writes changes to stdout without modifying the source file. Useful for testing changes.

Source:

streamEditor.js, line 267

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .preview(); // writes changes to stdout

preview()

Writes changes to stdout without modifying the source file. Useful for testing changes.

Source:

bufferedEditor.js, line 216

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .preview(); // writes changes to stdout

replace(source, replacement)

replaces a given string or regex for every line

Parameters:

Name	Type	Description
`source`	string \| RegExp
`replacement`	string

Source:

bufferedEditor.js, line 88

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .replace('x', 'y')
 .replace(/x/, 'y')
 .save();

replace(source, replacement)

replaces a given string or regex for every line

Parameters:

Name	Type	Description
`source`	string \| RegExp
`replacement`	string

Source:

streamEditor.js, line 140

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .replace('x', 'y')
 .replace(/x/, 'y')
 .save();

save()

Writes any modifications to the file

Source:

streamEditor.js, line 224

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .save();

save()

Writes any modifications to the file

Source:

bufferedEditor.js, line 173

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .save();

saveAs(filename)

Writes any modifications to a given file

Parameters:

Name	Type	Description
`filename`	string

Source:

bufferedEditor.js, line 194

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .saveAs('myFile');

saveAs(filename)

Writes any modifications to a given file

Parameters:

Name	Type	Description
`filename`	string

Source:

streamEditor.js, line 245

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .filter(fn)
 .map(fn)
 .saveAs('myFile');

set(line, n)

sets a line at a given line number N

Parameters:

Name	Type	Description
`line`	string
`n`	number

Source:

bufferedEditor.js, line 24

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .set(10, anotherline)
 .save();

set(line, n)

sets a line at a given line number N

Parameters:

Name	Type	Description
`line`	string
`n`	number

Source:

streamEditor.js, line 77

Returns:

Editor

Example

import FileSurgeon from 'FileSurgeon';

const contents = FileSurgeon.edit(filename)
 .set(1, line)
 .set(10, anotherline)
 .save();