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
  • Parameters
  • Properties
  • conformsTo
    • Parameters
  • toJSON
• UTIController
  • Properties
  • register
    • Parameters
  • getUTI
    • Parameters
  • getUTIsForMimeType
    • Parameters
  • getUTIsForFileName
    • Parameters
  • conformsTo
    • Parameters
  • fileNameConformsTo
    • Parameters

UTI

Object representing a UTI.

Parameters

• name string
• conforms Set<UTI>

Properties

• name string
• conforms Set<UTI>

conformsTo

Check for conformity.

Parameters

• other UTI

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

• registry Map<string, UTI>
• utiByMimeType Map<string, UTI>
• utiByFileNameExtension Map<string, UTI>

register

Registers additional types.

Parameters

• types Array<Object>

getUTI

Lookup a given UTI.

Parameters

• name string UTI

Returns string 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 string UTI for the given mime type or undefined if no UTI is registerd for the 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 string UTI for the given fileName or undefined if no UTI is registerd for the file names extension

conformsTo

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

Parameters

• a string first UTI
• b string second UTI

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 egainst

Returns boolean ture if utils for file name are conformant

install

With npm do:

npm install uti

license

BSD-2-Clause