https://github.com/airtucha/path2ct

Lookups correct MIME content-type for specified path and return it as a string
https://github.com/airtucha/path2ct

content-type http https mime path typescript

Last synced: 5 months ago
JSON representation

Lookups correct MIME content-type for specified path and return it as a string

• Host: GitHub
• URL: https://github.com/airtucha/path2ct
• Owner: AIRTucha
• License: mit
• Created: 2019-11-09T12:58:54.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-16T10:22:19.000Z (about 6 years ago)
• Last Synced: 2025-07-31T10:58:54.144Z (6 months ago)
• Topics: content-type, http, https, mime, path, typescript
• Language: TypeScript
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Path to content-type 

[![Build Status](https://travis-ci.org/AIRTucha/path2ct.svg?branch=master)](https://travis-ci.org/AIRTucha/path2ct)[![Coverage Status](https://coveralls.io/repos/github/AIRTucha/path2ct/badge.svg?branch=master)](https://coveralls.io/github/AIRTucha/path2ct?branch=master)

## Get started 

The package is available via npm. It has to be installed as a local dependency:

npm install path2ct

It consists of three pure functions which can be used to quickly get file extension or corespondent content type from a path.

## API

```typescript

getContentType: ( path: string) => string | undefined

```

Lookups correct MIME content-type for specified path and return it as a string. If extension can not be identified returns undefined.

```typescript

getContentTypeMaybe: (path: string) => Maybe

```

Works in a very similar way to *getContentType*, but returns Maybe of the string which is None if MIME type can not be identified.

```typescript

getExtension: (path: string) => string | undefined

```

Support function which helps to extract file extension from a path.

## Contribution guidelines

The project is based on *npm* eco-system. Therefore, development process is organized via *npm* scripts.

For installation of dependencies run

    npm install

To build application once

    npm run build

To build an application and watch for changes of files

    npm run build:w

To run tslint one time for CI

    npm run lint

To unit tests in a watching mode are performed by 

    npm run test

    

To execute a test suit single time

    npm run test:once

To execute a test suit single time with coverage report

    npm run test:c

To execute a test suit single time with coverage report submitted to *coveralls*

    npm run test:ci

Everybody is welcome to contribute and submit pull requests. Please communicate your ideas and suggestions via *issues*.