terminating-newline
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.4 • Public • Published

    terminating-newline

    NPM TypeScript Coverage Status GitHub Stars Twitter Follow

    Add or remove a terminating newline.

    Supports both line feeds (/n) and carriage return line feeds (/r/n). Will only add a newline if one does not already exist.

    Installation

    yarn add terminating-newline
    npm install terminating-newline

    API

    Usage

    import {
      addTerminatingNewline,
      removeTerminatingNewline,
      lineFeed, // "\n"
      carriageReturnLineFeed // "/r/n"
    } from "terminating-newline";
     
    addTerminatingNewline("abc", { default: lineFeed }); // "abc/n"
     
    addTerminatingNewline("abc\n", { default: lineFeed }); // "abc/n"
     
    removeTerminatingNewline("abc\n"); // "abc"
     

    Types

    function addTerminatingNewline(string: string, options?: Options): string;
    function addTerminatingNewline(buffer: Buffer, options?: Options): Buffer;
     
    function removeTerminatingNewline(string: string): string;
    function removeTerminatingNewline(buffer: Buffer): Buffer;
     
    type Options = {
      // Fallback if newline type cannot be determined. Default: "\n"
      default?: LineFeed | CarriageReturnLineFeed;
    }
     
    type LineFeed = "\n";
     
    type CarriageReturnLineFeed = "\r\n";

    Dependenciesdependencies


    Dev DependenciesDavid


    License license

    MIT

    Install

    npm i terminating-newline

    DownloadsWeekly Downloads

    164

    Version

    1.2.4

    License

    MIT

    Unpacked Size

    9.16 kB

    Total Files

    11

    Last publish

    Collaborators

    • bconnorwhite