uti
TypeScript icon, indicating that this package has built-in type declarations

8.4.1 • Public • Published

npm License Typed with TypeScript bundlejs downloads GitHub Issues Build Status Styled with prettier Commitizen friendly Known Vulnerabilities Coverage Status

uti

Uniform Type Identifier

Please see ars technica article for a description about the principles of UTIs.

For a list of known UTIs please see here

example

myuti.js

import { UTIController } from "uti";

const uc = new UTIController();
const doesConformTo = uc.conformsTo("public.image", "public.data");
console.log("doesConformTo: " + doesConformTo);

console.log(uc.getUTIsForFileName("a.txt")[0]);

Output

doesConformTo: true
public.plain-text

API

Table of Contents

UTI

Object representing a UTI.

Parameters

Properties

conformsTo

Check for conformity.

Parameters

Returns boolean true if other conforms to the receiver

toJSON

Deliver JSON representation of the UTI. Sample result

{
  "name": "myUTI",
  "conformsTo": [ "uti1", "uti2"]
}

Returns Object json representation of the UTI

UTIController

Registry of UTIs.

Properties

utiByMimeType

Type: Map<string, Array<string>>

utiByFileNameExtension

Type: Map<string, Array<string>>

register

Registers additional types.

Parameters

getUTI

Lookup a given UTI.

Parameters

Returns (string | undefined) UTI for the given name or undefined if UTI is not present.

getUTIsForMimeType

Lookup a UTIs for a mime type.

Parameters

  • mimeType string mime type to get UTIs for

Returns Array<string> UTIs for the given mime type

getUTIsForFileName

Lookup a UTI for a file name. First the file name extension is extracted. Then a lookup in the reistered UTIs for file name extions is executed.

Parameters

  • fileName string file to detect UTI for

Returns Array<string> UTIs for the given fileName

conformsTo

Check whenever two UTI are conformant. If a conforms to b and b conforms to c then a also conforms to c.

Parameters

Returns boolean true if UTI a conforms to UTI b.

fileNameConformsTo

Lookup a UTI for a file name and check conformance.

Parameters

  • fileName string file to detect UTI for
  • uti string to check conformance against

Returns boolean ture if utils for file name are conformant

install

With npm do:

npm install uti

license

BSD-2-Clause

Readme

Keywords

Package Sidebar

Install

npm i uti

Weekly Downloads

1,300

Version

8.4.1

License

BSD-2-Clause

Unpacked Size

43.4 kB

Total Files

8

Last publish

Collaborators

  • arlac77