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

``javascript
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

`txt
doesConformTo: true
public.plain-text
`

API

$3

* UTIDeclaration
* Properties
* UTI
* Parameters
* Properties
* name
* conforms
* conformsTo
* Parameters
* toString
* toJSON
* UTIController
* Properties
* registry
* utiByMimeType
* utiByFileNameExtension
* register
* Parameters
* getUTI
* Parameters
* getUTIsForMimeType
* Parameters
* getUTIsForFileName
* Parameters
* conformsTo
* Parameters
* fileNameConformsTo
* Parameters
* assignMimeTypes
* Parameters
* assignExtensions
* Parameters

UTIDeclaration

Type: Object

$3

* name string
* conformsTo (string | Array<string>)?
* mimeType (string | Array<string>)?
* fileNameExtension (string | Array<string>)?

UTI

Object representing a UTI.

$3

* name string
* conforms Set<UTI>

$3

* name string
* conforms Set<UTI>

$3

Type: string

$3

Type: Set<UTI>

$3

Check for conformity.

#### Parameters

* other (UTI | undefined)

Returns boolean true if other conforms to the receiver

$3

name of the UTI.

Returns string

$3

Deliver JSON representation of the UTI.
Sample result

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

Returns {name: string, conforms: Array<string>} json representation of the UTI

UTIController

Registry of UTIs.

$3

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

$3

Type: Map<string, UTI>

$3

Type: Map<string, Array<string>>

$3

Type: Map<string, Array<string>>

$3

Registers additional types.

#### Parameters

* types Array<UTIDeclaration>

$3

Lookup a given UTI.

#### Parameters

* name string UTI

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

$3

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

$3

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

#### Parameters

* fileName string file to detect UTI for

Returns Array<string> UTIs for the given fileName

$3

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.

$3

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 true if utils for file name are conformant

$3

Assign mime types to a UTI

#### Parameters

* uti string
* mimeTypes Array<string>

$3

Assign mime types to a UTI

#### Parameters

* uti string
* extensions Array<string>

install

With npm do:

`shell
npm install uti
``

license

BSD-2-Clause