@stdlib/fs-append-file

Append data to a file.

https://github.com/stdlib-js/fs-append-file

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

append appendfile appendfilesync appends async file filesystem fs javascript node node-js nodejs open path stdlib sync

Last synced: 4 months ago · JSON representation ·

Repository

Append data to a file.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 188 KB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

append appendfile appendfilesync appends async file filesystem fs javascript node node-js nodejs open path stdlib sync

Created over 1 year ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Append File

Append data to a file.

## Installation ```bash npm install @stdlib/fs-append-file ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var appendFile = require( '@stdlib/fs-append-file' ); ``` #### appendFile( file, data\[, options], clbk ) Asynchronously appends `data` to a `file`. ```javascript var join = require( 'path' ).join; var fpath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); appendFile( fpath, 'beep boop\n', onAppend ); function onAppend( error ) { if ( error ) { console.log( error instanceof Error ); // => false } } ``` The `data` argument may be either a `string` or a [`Buffer`][@stdlib/buffer/ctor]. ```javascript var join = require( 'path' ).join; var string2buffer = require( '@stdlib/buffer-from-string' ); var fpath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); appendFile( fpath, string2buffer( 'beep boop\n' ), onAppend ); function onAppend( error ) { if ( error ) { console.log( error instanceof Error ); // => false } } ``` The function accepts the same `options` and has the same defaults as [`fs.appendFile()`][node-fs]. #### appendFile.sync( file, data\[, options] ) Synchronously appends `data` to a `file`. ```javascript var join = require( 'path' ).join; var fpath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); var err = appendFile.sync( fpath, 'beep boop\n' ); if ( err instanceof Error ) { throw err; } ``` The function accepts the same `options` and has the same defaults as [`fs.appendFileSync()`][node-fs].

## Notes - The difference between this `appendFile.sync` and [`fs.appendFileSync()`][node-fs] is that [`fs.appendFileSync()`][node-fs] will throw if an `error` is encountered (e.g., if given a non-existent directory path) and this API will return an `error`. Hence, the following anti-pattern ```javascript var fs = require( 'fs' ); // Check for directory path existence to prevent an error being thrown... if ( fs.existsSync( '/path/to' ) ) { fs.appendFileSync( '/path/to/file.txt', 'beep boop\n' ); } ``` can be replaced by an approach which addresses existence via `error` handling. ```javascript var appendFile = require( '@stdlib/fs-append-file' ); // Explicitly handle the error... var err = appendFile.sync( '/path/to/file.txt', 'boop beep\n' ); if ( err instanceof Error ) { // You choose what to do... throw err; } ```

## Examples ```javascript var join = require( 'path' ).join; var appendFile = require( '@stdlib/fs-append-file' ); var fpath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); // Synchronously append data to a file: var error = appendFile.sync( fpath, 'beep boop\n', 'utf8' ); // Function successfully executes and returns null console.log( error instanceof Error ); // => false // Asynchronously append data to a file: appendFile( fpath, 'beep boop\n', onAppend ); function onAppend( error ) { if ( error ) { console.error( 'Error: %s', error.message ); } console.log( 'Success!!!' ); } ```

## CLI

## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/fs-append-file-cli ```

### Usage ```text Usage: append-file [options] Options: -h, --help Print this message. -V, --version Print the package version. --enc, --encoding encoding Encoding. Default: 'utf8'. --flag flag Flag. Default: 'a'. --mode mode Mode. Default: 0o666. ```

### Notes - Relative output file paths are resolved relative to the current working directory. - Errors are written to `stderr`. - File contents should be provided over `stdin` as part of a [standard stream][standard-stream] pipeline.

### Examples ```bash $ printf 'beep boop\n' | append-file ./examples/fixtures/file.txt ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 30

Last Year

Push event: 30

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- npm 16 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 4
Total maintainers: 4

npmjs.org: @stdlib/fs-append-file

Append data to a file.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.0.2
published over 1 year ago

Versions: 2
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 7 Last month

Rankings

Forks count: 14.3%

Stargazers count: 14.5%

Dependent repos count: 28.9%

Average: 29.5%

Dependent packages count: 42.1%

Downloads: 47.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

npmjs.org: @stdlib/fs-append-file-cli

Append data to a file.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.0.2
published over 1 year ago

Versions: 2
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 9 Last month

Rankings

Dependent repos count: 28.9%

Average: 42.1%

Dependent packages count: 42.1%

Downloads: 55.2%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/publish_cli.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/assert-is-browser ^0.2.1 development
@stdlib/assert-is-windows ^0.2.1 development
@stdlib/bench-harness ^0.2.1 development
@stdlib/buffer-from-string ^0.2.1 development
@stdlib/fs-unlink ^0.2.1 development
@stdlib/fs-write-file ^0.2.1 development
@stdlib/process-exec-path ^0.2.1 development
@stdlib/string-replace ^0.2.1 development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/cli-ctor ^0.2.1
@stdlib/fs-read-file ^0.2.1
@stdlib/process-cwd ^0.2.1
@stdlib/process-read-stdin ^0.2.1
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.1

@stdlib/fs-append-file

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Append File

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/fs-append-file

Rankings

Maintainers (4)

Funding

npmjs.org: @stdlib/fs-append-file-cli

Rankings

Maintainers (4)

Funding

Dependencies