0.0.0 • Published 3 years ago

parse-filename v0.0.0

Weekly downloads
-
License
CC0-1.0
Repository
github
Last release
3 years ago

parse-filename

Parse a File Name from a Given URL or Data Path

features

  • zero dependencies
  • cross-platform
  • ignores URL parameters

supported input

  • http and https urls, like https://example.org/folder/file.txt
  • ssh urls, like ubuntu@example.org:/tmp/test.txt
  • git urls, like git@github.com:DanielJDufour/parse-filename/README.md
  • unix filepaths, like /tmp/file.txt
  • windows filepaths, like C:\WINDOWS\explorer.exe
  • s3 urls, like s3://bucket/file.txt

install

npm install parse-filename

usage

importing/loading

import parseFileName from 'parse-filename'

or

const parseFileName = require('parse-filename');

or

<script src="https://unpkg.com/parse-filename">

parsing

const result = parseFileName({
  data: "https://github.com/DanielJDufour/parse-filename/blob/main/README.md",
  debug: false // set to true for increased logging
});
// result is { extension: "md", filename: "README.md" }

advanced usage

You can specify three additional arguments

const result = parseFileName({
  data: "https://example.org/testpath/f.zip",
  max_extension_length = 10,
  min_extension_length = 1,
  min_filename_length = 3
});
// returns { extension: null, filename: null } because filename is too short