1.0.6 • Published 4 months ago
my-dj-client v1.0.6
MyDj Client API
A TypeScript client for interacting with the MyDj API.
Installation
npm install my-dj-client
Configuration
Environment Variables
Create a .env
file in your project root with the following variables:
# Base URL for the MyDj API
API_BASE_URL=https://api.mydj.com
# Supabase Project Configuration
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_ANON_KEY=your-supabase-anon-key
Usage
Basic Usage
import { createDjApiClient } from "my-dj-client";
import { createClient } from "@supabase/supabase-js";
// If not using environment variables, you can pass configuration directly
const supabaseClient = createClient(
"YOUR_SUPABASE_URL",
"YOUR_SUPABASE_ANON_KEY"
);
const client = createDjApiClient({
supabaseClient,
baseUrl: "https://api.mydj.com", // Example URL
});
// Example: Creating an event
async function createEvent() {
const event = await client.events.create({
handle: "summer-party",
title: "Summer Party",
startTime: new Date(),
endTime: new Date(),
});
}
Using Environment Variables
If you have a .env
file configured, you can simply call:
import { createDjApiClient } from "my-dj-client";
// Will automatically use environment variables
const client = createDjApiClient();
Features
- Fully typed API client
- Supports environment variable configuration
- Easy-to-use resource-based methods
- Built-in error handling
Resources
- Authentication
- Events
- Song Requests
- Subscriptions
- Profiles
License
ISC