UNPKG

6.15 kBMarkdownView Raw
1[![npm](https://img.shields.io/npm/v/aflb.svg)](https://www.npmjs.com/package/aflb)
2[![npm](https://img.shields.io/npm/dt/aflb.svg?maxAge=3600)](https://www.npmjs.com/package/aflb)
3[![install size](https://packagephobia.now.sh/badge?p=aflb)](https://packagephobia.now.sh/result?p=aflb)
4
5
6[![NPM](https://nodei.co/npm/aflb.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/aflb/)
7
8# AFLB ¯\_(ツ)_/¯
9
10![aflb](https://cdn.discordapp.com/attachments/814183405901053992/894023623990468618/aflb_banner.png)
11
12## Installation
13```
14npm i aflb
15```
16Huge anime action gifs with no external dependencies.
17
18### SFW Action Gifs
19
20| Function | Description |
21| -------- | ----------- |
22| `angry` | Gets a URL of a angry image/gif |
23| `baka` | Gets a URL of a baka image/gif |
24| `bite` | Gets a URL of a bite image/gif |
25| `bloodsuck` | Gets a URL of a bloodsuck image/gif |
26| `blush` | Gets a URL of a blush image/gif |
27| `bored` | Gets a URL of a bored image/gif |
28| `kissCheek` | Gets a URL of a kissing cheek image/gif |
29| `cheek` | Gets a URL of a squeeze cheeks image/gif |
30| `clap` | Gets a URL of a clap image/gif |
31| `cringe` | Gets a URL of a cringe image/gif |
32| `cry` | Gets a URL of a cry image/gif |
33| `dance` | Gets a URL of a dance image/gif |
34| `drink` | Gets a URL of a drink image/gif |
35| `facedesk` | Gets a URL of a facedesk image/gif |
36| `fight` | Gets a URL of a fight image/gif |
37| `happy` | Gets a URL of a happy image/gif |
38| `hate` | Gets a URL of a hate image/gif |
39| `highfive` | Gets a URL of a highfive image/gif |
40| `horny` | Gets a URL of a horny image/gif |
41| `kill` | Gets a URL of a kill image/gif |
42| `hand` | Gets a URL of a hand image/gif |
43| `laugh` | Gets a URL of a laugh image/gif |
44| `lick` | Gets a URL of a lick image/gif |
45| `lurk` | Gets a URL of a lurk image/gif |
46| `meow` | Gets a URL of a meow image/gif |
47| `nom` | Gets a URL of a nom image/gif |
48| `feed` | Gets a URL of a feed image/gif |
49| `hug` | Gets a URL of a hug image/gif |
50| `nuzzle` | Gets a URL of a nuzzle image/gif |
51| `kiss` | Gets a URL of a kiss image/gif |
52| `pat` | Gets a URL of a pat image/gif |
53| `tickle` | Gets a URL of a tickle image/gif |
54| `poke` | Gets a URL of a poke image/gif |
55| `smug` | Gets a URL of a smug image/gif |
56| `stare` | Gets a URL of a stare image/gif |
57| `panic` | Gets a URL of a panic image/gif |
58| `nya` | Gets a URL of a nya image/gif |
59| `pout` | Gets a URL of a pout image/gif |
60| `run` | Gets a URL of a run image/gif |
61| `sad` | Gets a URL of a sad image/gif |
62| `sake` | Gets a URL of a drink sake image/gif |
63| `shoot` | Gets a URL of a shoot image/gif |
64| `sip` | Gets a URL of a all sip image/gif |
65| `sipTea` | Gets a URL of a sip tea image/gif |
66| `sipCoffee` | Gets a URL of a sip coffee image/gif |
67| `sipJuice` | Gets a URL of a sip juice image/gif |
68| `slap` | Gets a URL of a all slap/punch/hit image/gif |
69| `slapAss` | Gets a URL of a slap ass image/gif |
70| `slapCheek` | Gets a URL of a smack image/gif |
71| `sleep` | Gets a URL of a all sleep image/gif |
72| `sleepSolo` | Gets a URL of a solo sleep image/gif |
73| `sleepTogether` | Gets a URL of a together sleep image/gif |
74| `smile` | Gets a URL of a smile image/gif |
75| `smoke` | Gets a URL of a smoke image/gif |
76| `steal` | Gets a URL of a steal image/gif |
77| `stockings` | Gets a URL of a stockings image/gif |
78| `sweeties` | Gets a URL of a sweeties image/gif |
79| `wasted` | Gets a URL of a wasted image/gif |
80| `wave` | Gets a URL of a wave image/gif |
81| `tease` | Gets a URL of a wave image/gif |
82| `wink` | Gets a URL of a wink image/gif |
83| `sex` | Gets a URL of a (NO NSFW) sex image/gif |
84| `cuddle` | Gets a URL of a cuddle image/gif |
85
86### SFW Other Gif/Image
87| Function | Description |
88| -------- | ----------- |
89| `mix` | Gets a URL of a cute neko, kitsune image/gif |
90| `neko` | Gets a URL of a cute neko image/gif |
91| `nekoImg` | Gets a URL of a cute neko image |
92| `nekoGif` | Gets a URL of a cute neko gif |
93| `kitsune` | Gets a URL of a cute kitsune image |
94
95### NSFW Gifs
96
97### NSFW content is not yet available, coming soon..
98
99| Function | Description |
100| -------- | ----------- |
101| `ass` | Gets a URL of a ass image/gif |
102
103## Typings
104
105I added a typings file and will be working to improve it. This allows editors like VSC to use intellisense/autocomplete to suggest functions and help out with parameters and to see what you'll be receiving as a result of function calls.
106
107
108## Examples
109
110Await/Async example
111```js
112const client = require('aflb');
113const aflb = new client();
114
115async function getKissImage() {
116 console.log(await aflb.sfw.kiss());
117}
118
119getKissImage();
120```
121returns:
122```json
123"https://cdn.discordapp.com/attachments/820213553540759571/894020186611548230/kiss_01.gif"
124```
125
126Standart Usage
127```js
128const client = require('aflb');
129const aflb = new client();
130
131console.log(aflb.sfw.kiss())
132
133```
134returns:
135```json
136"https://cdn.discordapp.com/attachments/820213553540759571/894021582819835904/kiss_02.gif"
137```
138
139Usage in Embed
140```js
141const { MessageEmbed } = require('discord.js')
142const client = require('aflb');
143const aflb = new client();
144
145const embed = new MessageEmbed().setImage(aflb.sfw.kiss())
146```
147returns:
148```json
149"https://cdn.discordapp.com/attachments/820213553540759571/894021582819835904/kiss_02.gif"
150```
151![Embed Usage](https://cdn.discordapp.com/attachments/820213553540759571/894023119101120572/embed_usage.png)
152
153
154## Extended Examples
155
156The examples show only the import of the sfw / nsfw module, in case you don't need the second part.
157
158Import only sfw content
159```js
160const client = require('aflb');
161const { sfw } = new client();
162
163console.log(sfw.kiss())
164
165```
166returns:
167```json
168"https://cdn.discordapp.com/attachments/820213553540759571/894021582819835904/kiss_02.gif"
169```
170
171Import only nsfw content
172```js
173const client = require('aflb');
174const { nsfw } = new client();
175
176console.log(nsfw.ass())
177
178```
179returns:
180```json
181"https://cdn.discordapp.com/attachments/820213553540759571/894021582819835904/mega-nsfw.gif"
182```