kiutils

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>kiutils</title><meta name="description" content="Documentation for kiutils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base="."> <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></div></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">kiutils</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> <div class="container container-main"> <div class="col-content"> <div class="tsd-page-title"> <h2>kiutils</h2></div> <div class="tsd-panel tsd-typography"><div align="center"> <h1>🎑 kiutils</h1> A powerful JavaScript/TypeScript utility library for image manipulation, Discord utilities, and more! <a href="https://www.npmjs.org/package/kiutils"><img src="https://img.shields.io/npm/v/kiutils.svg?style=flat-square" alt="npm version"></a> <a href="http://npm-stat.com/charts.html?package=kiutils"><img src="https://img.shields.io/npm/dm/kiutils.svg?style=flat-square" alt="npm downloads"></a> <a href="https://github.com/YoruAkio/kiutils/blob/main/LICENSE"><img src="https://img.shields.io/github/license/YoruAkio/kiutils" alt="License"></a> </div> <a id="md:✨-features" class="tsd-anchor"></a><h2><a href="#md:✨-features">✨ Features</a></h2><ul> <li>🖼️ Image Manipulation - Convert, resize, and create thumbnails with ease</li> <li>🤖 Discord Utilities - Create beautiful rank cards and other Discord-related graphics</li> <li>📝 Code Sharing - Share code snippets via SourceBin</li> <li>🌸 Anime Images - Fetch waifu images with a simple API</li> <li>🧰 Utility Functions - Various helper functions for common tasks</li> </ul> <a id="md:📦-installation" class="tsd-anchor"></a><h2><a href="#md:📦-installation">📦 Installation</a></h2><pre><code class="language-bash"># Using npm npm install kiutils # Using yarn yarn add kiutils # Using pnpm pnpm add kiutils </code><button>Copy</button></pre> <a id="md:🚀-quick-start" class="tsd-anchor"></a><h2><a href="#md:🚀-quick-start">🚀 Quick Start</a></h2><pre><code class="language-typescript">// Import the modules you need const { Canvas, Discord, waifu, convertImage, ImageFormat } = require('kiutils'); // OR with ES modules import { Canvas, Discord, waifu, convertImage, ImageFormat } from 'kiutils'; </code><button>Copy</button></pre> <a id="md:📚-usage-examples" class="tsd-anchor"></a><h2><a href="#md:📚-usage-examples">📚 Usage Examples</a></h2><a id="md:image-conversion" class="tsd-anchor"></a><h3><a href="#md:image-conversion">Image Conversion</a></h3><pre><code class="language-typescript">import { convertImage, ImageFormat } from 'kiutils'; import * as fs from 'fs'; // Convert an image to WebP format const convertToWebP = async () => { const buffer = await convertImage('input.jpg', ImageFormat.WEBP, { quality: 80, width: 800 }); fs.writeFileSync('output.webp', buffer); console.log('Image converted successfully!'); }; convertToWebP(); </code><button>Copy</button></pre> <a id="md:creating-discord-rank-cards" class="tsd-anchor"></a><h3><a href="#md:creating-discord-rank-cards">Creating Discord Rank Cards</a></h3><pre><code class="language-typescript">import { Discord } from 'kiutils'; import * as fs from 'fs'; const createRankCard = async () => { const rankCard = await new Discord().createRankCard({ username: { name: 'CoolUser#1234' }, level: { data: 15, display: true }, rank: { data: 12, display: true }, currentXP: { data: 500 }, requiredXP: { data: 1000 }, avatar: { source: 'https://i.imgur.com/example.png' }, status: { type: 'online' }, progressBar: { bar: { type: 'gradient', color: ['#5865F2', '#EB459E'] } } }); fs.writeFileSync('rank-card.png', rankCard); console.log('Rank card created!'); }; createRankCard(); </code><button>Copy</button></pre> <a id="md:fetching-waifu-images" class="tsd-anchor"></a><h3><a href="#md:fetching-waifu-images">Fetching Waifu Images</a></h3><pre><code class="language-typescript">import { waifu, WaifuType } from 'kiutils'; const getWaifuImage = async () => { const imageUrl = await waifu(WaifuType.SFW); console.log(`Waifu image URL: ${imageUrl}`); }; getWaifuImage(); </code><button>Copy</button></pre> <a id="md:simple-canvas-creation" class="tsd-anchor"></a><h3><a href="#md:simple-canvas-creation">Simple Canvas Creation</a></h3><pre><code class="language-typescript">import { Canvas } from 'kiutils'; import * as fs from 'fs'; const createCanvas = async () => { const canvas = new Canvas({ width: 800, height: 400, background: { color: '#5865F2', image: 'color' }, fontColor: '#FFFFFF' }); const buffer = await canvas.renderWithText('Hello World!', { font: '40px Arial', align: 'center' }); fs.writeFileSync('canvas.png', buffer); console.log('Canvas created!'); }; createCanvas(); </code><button>Copy</button></pre> <a id="md:sharing-code-on-sourcebin" class="tsd-anchor"></a><h3><a href="#md:sharing-code-on-sourcebin">Sharing Code on SourceBin</a></h3><pre><code class="language-typescript">import { bin } from 'kiutils'; const shareCode = async () => { const code = ` function helloWorld() { console.log('Hello from kiutils!'); } helloWorld(); `; const url = await bin(code); console.log(`Code shared at: ${url}`); }; shareCode(); </code><button>Copy</button></pre> <a id="md:📋-api-documentation" class="tsd-anchor"></a><h2><a href="#md:📋-api-documentation">📋 API Documentation</a></h2>For complete API documentation, please visit our <a href="https://github.com/YoruAkio/kiutils#readme">documentation website</a>. <a id="md:🤝-contributing" class="tsd-anchor"></a><h2><a href="#md:🤝-contributing">🤝 Contributing</a></h2>Contributions, issues and feature requests are welcome! Feel free to check the <a href="https://github.com/YoruAkio/kiutils/issues">issues page</a>. <a id="md:📝-license" class="tsd-anchor"></a><h2><a href="#md:📝-license">📝 License</a></h2>This project is <a href="https://github.com/YoruAkio/kiutils/blob/main/LICENSE">MIT</a> licensed. </div></div> <div class="col-sidebar"> <div class="page-menu"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <ul id="tsd-filter-options"> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></form></div> <div class="tsd-theme-toggle"> <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> <div class="tsd-accordion-details"> <ul> <li> <ul> <li><a href="#md:✨-features">✨ Features</a></li> <li> <ul> <li><a href="#md:📦-installation">📦 Installation</a></li> <li><a href="#md:🚀-quick-start">🚀 Quick Start</a></li> <li><a href="#md:📚-usage-examples">📚 Usage Examples</a></li> <li> <ul> <li><a href="#md:image-conversion">Image Conversion</a></li> <li><a href="#md:creating-discord-rank-cards">Creating Discord Rank Cards</a></li> <li><a href="#md:fetching-waifu-images">Fetching Waifu Images</a></li> <li><a href="#md:simple-canvas-creation">Simple Canvas Creation</a></li> <li><a href="#md:sharing-code-on-sourcebin">Sharing Code on SourceBin</a></li></ul></li> <li><a href="#md:📋-api-documentation">📋 API Documentation</a></li> <li><a href="#md:🤝-contributing">🤝 Contributing</a></li> <li><a href="#md:📝-license">📝 License</a></li></ul></li></ul></li></ul></div></details></div> <div class="site-menu"> <nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg>kiutils</a> <ul class="tsd-small-nested-navigation"> <li><a href="enums/BackgroundType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg>BackgroundType</a></li> <li><a href="enums/ImageFormat.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>ImageFormat</a></li> <li><a href="enums/ProgressBarType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>ProgressBarType</a></li> <li><a href="enums/StatusType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>StatusType</a></li> <li><a href="enums/WaifuType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>WaifuType</a></li> <li><a href="classes/Canvas.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg>Canvas</a></li> <li><a href="classes/Discord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Discord</a></li> <li><a href="classes/Utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Utils</a></li> <li><a href="interfaces/CanvasData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg>CanvasData</a></li> <li><a href="interfaces/ConversionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversionOptions</a></li> <li><a href="interfaces/RankData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>RankData</a></li> <li><a href="types/A.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg>A</a></li> <li><a href="types/BackgroundTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>BackgroundTypes</a></li> <li><a href="types/ImageFormats.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>ImageFormats</a></li> <li><a href="types/ProgressBarTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>ProgressBarTypes</a></li> <li><a href="types/StatusTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>StatusTypes</a></li> <li><a href="functions/bin.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg>bin</a></li> <li><a href="functions/convertImage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>convertImage</a></li> <li><a href="functions/convertImageFile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>convertImageFile</a></li> <li><a href="functions/createThumbnail.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>createThumbnail</a></li> <li><a href="functions/print.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>print</a></li> <li><a href="functions/randString.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>randString</a></li> <li><a href="functions/waifu.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg>waifu</a></li></ul></nav></div></div></div> <div class="tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div> <div class="overlay"></div></body></html>