@@ -4,11 +4,17 @@ Cat as a service API wrapper for Javascript and Typescript.
4
4
5
5
> Cat as a service is a REST API to spread peace and love (or not) thanks to cats.
6
6
7
+ ## Install
8
+
9
+ ` npm install --save cataas-api `
10
+
7
11
## Examples
8
12
9
13
` constructor() `
10
14
11
15
``` JS
16
+ var Cataas = require (' cataas-api' )
17
+ var cataas = new Cataas ()
12
18
var gif = {
13
19
Gif: true ,
14
20
Size: ' md' ,
@@ -21,28 +27,25 @@ var resized = {
21
27
Width: 300 ,
22
28
Height: 200 ,
23
29
}
24
- var cataas = new Cataas ( gif)
30
+ cataas . options = gif
25
31
cataas .options = resized
26
32
```
27
33
28
34
` encode() `
29
35
30
36
``` JS
31
- var cataas = new Cataas ()
32
37
var encodedUrl = cataas .encode ()
33
38
```
34
39
35
40
` encodeById(id) `
36
41
37
42
``` JS
38
- var cataas = new Cataas ()
39
43
var encodedUrl = cataas .encodeById (' [ID]' )
40
44
```
41
45
42
46
` async get() `
43
47
44
48
``` JS
45
- var cataas = new Cataas ()
46
49
cataas .encode ()
47
50
cataas .get ()
48
51
.then (readable => {
@@ -55,7 +58,6 @@ cataas.get()
55
58
` async download(path) `
56
59
57
60
``` JS
58
- var cataas = new Cataas ()
59
61
cataas .encode ()
60
62
cataas .download (' cat.png' )
61
63
.then (successful => {
@@ -69,7 +71,6 @@ cataas.download('cat.png')
69
71
` async getAllTags() `
70
72
71
73
``` JS
72
- const cataas = new Cataas ()
73
74
cataas .encode ()
74
75
cataas .getAllTags ()
75
76
.then (tags => {
@@ -81,14 +82,30 @@ cataas.getAllTags()
81
82
` async getCats(tags, options) `
82
83
83
84
``` JS
84
- var cataas = new Cataas ()
85
85
cataas .encode ()
86
86
cataas .getCats ([' cute' ])
87
87
.then (cats => console .log (' Results length:' , cats .length ))
88
88
.catch (e => console .error (e))
89
89
```
90
90
91
- #### Tips:
91
+ ### Typescript example
92
+
93
+ ``` TS
94
+ import Cataas from ' cataas-api' ;
95
+
96
+ const cataas = new Cataas ()
97
+ cataas .options .Filter = " pixel"
98
+ cataas .encode ()
99
+ cataas .getCats ([' cute' ], { Limit: 5 })
100
+ .then (cats => {
101
+ cats .forEach (cat => {
102
+ console .log (` ${cat .id }: ${cat .tags } ` ))
103
+ }
104
+ })
105
+ .catch (e => console .error (e ))
106
+ ` ` `
107
+
108
+ #### Tips
92
109
93
110
+ After setting ` Gif : true ` in options, ` Tag ` is ignored
94
111
+ Don't forget to ` encode ()` | ` encodeById ` before ` get ()` | ` download ()`
0 commit comments