Directory SDK

Directory and catalog management

Installation

pnpm add sdk.do

Quick Start

import { $ } from 'sdk.do'

// Basic usage
$.directory()

API Reference

Main Methods

`$.directory()`

Main entry point for directory.do operations.

$.directory()

Parameters:

Configuration object specific to directory.do

Returns:

Promise resolving to operation result

Configuration

interface DirectoryConfig {
  // Configuration options for directory.do
  options?: Record<string, any>
  timeout?: number
  retries?: number
}

Usage Examples

Basic Example

import { $ } from 'sdk.do'

// Simple usage
$.directory()

Advanced Example

import { $, on, send } from 'sdk.do'

// Advanced usage with event handling
$.directory()

// Listen for events
on('directory.completed', async (result) => {
  console.log('Operation completed:', result)
  await send('notification.sent', { result })
})

Error Handling

try {
  $.directory()
} catch (error) {
  if (error.code === 'TIMEOUT') {
    // Handle timeout
    console.error('Operation timed out')
  } else if (error.code === 'VALIDATION_ERROR') {
    // Handle validation error
    console.error('Invalid input:', error.message)
  } else {
    throw error
  }
}

TypeScript Support

Full TypeScript support with type inference:

import type { DirectoryResult, DirectoryConfig } from 'sdk.do'

const config: DirectoryConfig = {
  // Fully typed configuration
}

const result: DirectoryResult = await $.directory(config)

Integration with Events

import { $, on, send } from 'sdk.do'

// Trigger on event
on('user.created', async (user) => {
  $.directory()
})

// Send event after completion
const result = await $.directory({
  /* config */
})
await send('directory.completed', result)

Best Practices

Error Handling - Always wrap operations in try/catch
Type Safety - Use TypeScript types for better DX
Event Integration - Leverage event system for workflows
Configuration - Use environment variables for sensitive data
Monitoring - Track operations for debugging

Directory SDK

On this page