1
- # tiff
2
-
3
- TIFF image decoder written entirely in JavaScript.
4
-
5
1
<h3 align =" center " >
6
-
7
2
<a href =" https://www.zakodium.com " >
8
3
<img src="https://www.zakodium.com/brand/zakodium-logo-white.svg" width="50" alt="Zakodium logo" />
9
4
</a >
10
-
11
5
<p >
12
6
Maintained by <a href="https://www.zakodium.com">Zakodium</a>
13
7
</p >
8
+ </h3 >
9
+
10
+ # tiff
14
11
15
12
[ ![ NPM version] [ npm-image ]] [ npm-url ]
16
- [ ![ build status] [ ci-image ]] [ ci-url ]
17
13
[ ![ npm download] [ download-image ]] [ download-url ]
14
+ [ ![ test coverage] [ codecov-image ]] [ codecov-url ]
15
+ [ ![ license] [ license-image ]] [ license-url ]
18
16
19
- </ h3 >
17
+ TIFF image decoder written entirely in TypeScript.
20
18
21
19
## Installation
22
20
@@ -37,7 +35,7 @@ Images compressed with Zlib/deflate algorithm are also supported.
37
35
38
36
## API
39
37
40
- ### tiff.decode(data[ , options] )
38
+ ### ` tiff.decode(data[, options]) `
41
39
42
40
Decodes the file and returns TIFF IFDs.
43
41
@@ -62,11 +60,11 @@ The `data` property is a Typed Array containing the pixel data. It is a
62
60
- ` yResolution `
63
61
- ` resolutionUnit `
64
62
65
- ### tiff.pageCount(data)
63
+ ### ` tiff.pageCount(data) `
66
64
67
65
Returns the number of IFDs (pages) in the file.
68
66
69
- ### tiff.isMultiPage(data)
67
+ ### ` tiff.isMultiPage(data) `
70
68
71
69
Returns true if the file has 2 or more IFDs (pages) and false if it has 1.
72
70
This is slightly more efficient than calling ` pageCount() ` if all you need to
@@ -78,9 +76,9 @@ know is whether the file has multiple pages or not.
78
76
79
77
[ npm-image ] : https://img.shields.io/npm/v/tiff.svg
80
78
[ npm-url ] : https://www.npmjs.com/package/tiff
81
- [ ci-image ] : https://github.com/image-js/tiff/workflows/Node.js%20CI/badge.svg?branch=main
82
- [ ci-url ] : https://github.com/image-js/tiff/actions?query=workflow%3A%22Node.js+CI%22
83
- [ codecov-image ] : https://img.shields.io/codecov/c/github/image-js/tiff.svg
84
- [ codecov-url ] : https://codecov.io/gh/image-js/tiff
85
79
[ download-image ] : https://img.shields.io/npm/dm/tiff.svg
86
80
[ download-url ] : https://www.npmjs.com/package/tiff
81
+ [ codecov-image ] : https://img.shields.io/codecov/c/github/image-js/tiff.svg
82
+ [ codecov-url ] : https://app.codecov.io/gh/image-js/tiff
83
+ [ license-image ] : https://img.shields.io/npm/l/tiff.svg
84
+ [ license-url ] : https://github.com/image-js/tiff/blob/main/LICENSE
0 commit comments