Emoji Dock API

Installation

npm install @emojidock/sdk

Quick Start

import { EmojiDock } from '@emojidock/sdk';

const dock = new EmojiDock({ apiKey: 'YOUR_API_KEY' });

// Search emojis
const results = await dock.search('happy');
console.log(results);
// [{ emoji: "😀", name: "Grinning Face", ... }, ...]

// Get all emojis (paginated)
const page = await dock.list({ page: 1, limit: 50 });

// Get a single emoji by slug
const heart = await dock.get('red-heart');

// Get all categories
const categories = await dock.categories();

// List event/topic packs
const packs = await dock.packs({ month: 12 });

// Get a specific pack
const christmas = await dock.pack('christmas');

SDK Methods

Configuration

const dock = new EmojiDock({
  apiKey: 'YOUR_API_KEY',       // Required — get one free
  baseUrl: 'https://api.emojidock.com/v1', // Optional — defaults to production
  cache: true,                   // Optional — enable in-memory cache (default: true)
  cacheTTL: 60000,               // Optional — cache TTL in ms (default: 60s)
  retries: 2,                    // Optional — auto-retry on failure (default: 2)
  timeout: 5000,                 // Optional — request timeout in ms (default: 5s)
});

TypeScript Types

import type { Emoji, Category, Pack, Contributor } from '@emojidock/sdk';

// Full type safety on all responses
const results: Emoji[] = await dock.search('fire');

interface Emoji {
  emoji: string;
  name: string;
  slug: string;
  category: string;
  subcategory: string;
  codepoints: string[];
  shortcode: string;
  description: string;
  keywords: string[];
  unicode: string;
  introduced: string;
}

Framework Examples

import { useState, useEffect } from 'react';
import { EmojiDock } from '@emojidock/sdk';

const dock = new EmojiDock({ apiKey: 'YOUR_API_KEY' });

function useEmojiSearch(query: string) {
  const [results, setResults] = useState([]);
  const [loading, setLoading] = useState(false);

  useEffect(() => {
    if (!query.trim()) { setResults([]); return; }
    setLoading(true);
    dock.search(query)
      .then(setResults)
      .finally(() => setLoading(false));
  }, [query]);

  return { results, loading };
}

const { EmojiDock } = require('@emojidock/sdk');
const dock = new EmojiDock({ apiKey: process.env.EMOJIDOCK_API_KEY });

app.get('/api/emojis', async (req, res) => {
  const { q } = req.query;
  const emojis = await dock.search(q);
  res.json(emojis);
});