Code Monkey home page Code Monkey logo

escape-filename's Introduction

escape-filename

Convert string to safe filename for Unix or Windows, But still look similar for reading

  • Unix-like System Rereserved: /
  • Windows System Rereserved: <>:"/\|?*

Install

$ npm install escape-filename

Usage

const escapeFile = require('escape-filename')
const fs = require('fs')

const str = 'foo / bar : | * \\.test'
const escaped = escapeFile.escape(str)
// => "foo ∕ bar ꞉ ❘ ﹡ ﹨.test"

fs.writeFile(escaped, 'test filename', err => {
  if (!err) {
    console.log('write success')
  }
})

Api

escapeFile.escape(fileName)

Escape filename

escapeFile.unescape(escapedFileName)

Unescape filename

escapeFile.isEqual(fileName, escapedFileName)

Compare two string after unescape filename

Reference

License

ISC

escape-filename's People

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.