Skip to content

ajeetshah/name-on-copy

Repository files navigation

name-on-copy

Codacy Badge MIT License PRs Welcome FOSSA Status lerna

Generate new names on copy.

Installation

$ npm i name-on-copy

# or

$ yarn add name-on-copy

Usage

import nameOnCopy from 'name-on-copy'
// or
const nameOnCopy = require('name-on-copy').default

nameOnCopy('hello', ['hello'])
// hellocopy

nameOnCopy('hello', ['hello', 'hellocopy'])
// hellocopy2

nameOnCopy('world', ['hello', 'hellocopy', 'world'])
// worldcopy

API

Syntax

nameOnCopy(source, names [, options])

Arguments

Argument Description Type Required? Default value
source Name of source i.e. item name being copied string required ''
names Array of names existing currently string[] required []
options.suffix The suffix to be used in the name being generated string optional 'copy'
options.useSpaces When true, a space will be added between source and suffix. When false, no space will be added. boolean optional false
options.isFileName When true, source will be treated as a filename and file extension will be preserved in generated name. E.g. hello.txt -> hellocopy.txt boolean optional false

License

Freely distributed under the terms of the MIT license

FOSSA Status


Development

Packages: