https://github.com/ditschedev/filename-utils

A tiny yet powerfull collection of utils for processing filenames compareable to Apaches FilenameUtils for Java
https://github.com/ditschedev/filename-utils

extension filename filename-extension filename-utils javascript module utils

Last synced: 3 months ago
JSON representation

A tiny yet powerfull collection of utils for processing filenames compareable to Apaches FilenameUtils for Java

• Host: GitHub
• URL: https://github.com/ditschedev/filename-utils
• Owner: ditschedev
• Created: 2020-05-02T19:20:27.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T05:17:23.000Z (over 1 year ago)
• Last Synced: 2024-03-15T08:06:30.562Z (about 1 year ago)
• Topics: extension, filename, filename-extension, filename-utils, javascript, module, utils
• Language: TypeScript
• Size: 106 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# filename-utils

A tiny module written in TypeScript to help you with your filenames. A JavaScript version of the Apache FilenameUtils

class.

![build](https://img.shields.io/github/workflow/status/ditschedev/filename-utils/ci?style=for-the-badge)

![npm version](https://img.shields.io/github/package-json/v/ditschedev/filename-utils?style=for-the-badge)

![npm downloads](https://img.shields.io/npm/dt/filename-utils?style=for-the-badge)

![dependencies](https://david-dm.org/ditschedev/filename-utils.svg)

![License](https://img.shields.io/github/license/ditschedev/filename-utils?style=for-the-badge)

## Installation

To install the module, use your preferred package manager.

```yarn

yarn add filename-utils

```

or use npm

```npm

npm install filename-utils

```

## Usage

First you need to import the functions you need from `filename-utils`.

```typescript

import { getExtension, getBaseName } from 'filename-utils';

```

After that you can use the functions as you'd like!.

#### `getExtension(filename: string): string`

Fetches the extension of a filename. Will return an empty string, if no filename can be resolved. Examples:

```typescript

getExtension('image.png'); // returns => "png"

getExtension('image.test.jpeg'); // returns => "jpeg"

getExtension('shellscript'); // returns => ""

getExtension('.htaccess'); // returns => ""

```

#### `getBaseName(filename: string): string`

Strips the extension off the filename and returns the base name.

```typescript

getBaseName('image.png'); // returns => "image"

getBaseName('image.test.jpeg'); // returns => "image.test"

getBaseName('file'); // returns => "file"

getBaseName('.env'); // returns => ""

```