Skip to content

jrf0110/editor-in

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Editor In

Opens an editor, gets the result after the process has exited

Install:

npm install editor-in

Usage:

var editorIn = require('editor-in');

// Opens process.env.EDITOR
editorIn( function( error, result ){
  // result is a Buffer
  console.log( result.toString() );
});

Editor In

API

This module exports a single function

editorIn( [options], callback )

Opens a temporary file in options.editor or process.env.EDITOR and returns the result.

Options:

// Options and defaults
{
  // Editor to use Ex: 'vim'
  editor:         process.env.EDITOR || 'vi'
  // Initial content for the editor
, content:        ''
  // Prefix of tmp filename Ex: 'some-file-'
, tmpFilePrefix:  ''
  // Suffix of tmp filename Ex: '.md'
, tmpFilePostfix: ''
}

About

Node module for getting text input from a text editor

Resources

Stars

Watchers

Forks

Packages

No packages published