Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,22 @@
* @module @stdlib/_tools/licenses/insert-header-file-list
*
* @example
* var join = require( 'path' ).join;
* var readFile = require( '@stdlib/fs/read-file' ).sync;
* var writeFile = require( '@stdlib/fs/write-file' ).sync;
* var unlink = require( '@stdlib/fs/unlink' ).sync;
* var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
*
* // Create a temporary file:
* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
* var err = writeFile( tmp, readFile( src ) );
* if ( err ) {
* throw err;
* }
*
* var files = [
* './foo/bar.js'
* tmp
* ];
*
* var header = '// This file is licensed under Apache-2.0.';
Expand All @@ -38,21 +50,37 @@
* if ( error ) {
* throw error;
* }
* // Remove the temporary file:
* unlink( tmp );
* }
*
* @example
* var join = require( 'path' ).join;
* var readFile = require( '@stdlib/fs/read-file' ).sync;
* var writeFile = require( '@stdlib/fs/write-file' ).sync;
* var unlink = require( '@stdlib/fs/unlink' ).sync;
* var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
*
* // Create a temporary file:
* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
* var err = writeFile( tmp, readFile( src ) );
* if ( err ) {
* throw err;
* }
*
* var files = [
* './foo/bar.js'
* tmp
* ];
*
* var header = '// This file is licensed under Apache-2.0.';
*
* var err = insertHeader.sync( files, header );
* err = insertHeader.sync( files, header );
* if ( err instanceof Error ) {
* throw err;
* }
* // Remove the temporary file:
* unlink( tmp );
*/

// MODULES //
Expand Down
Loading