lokalise-sdk-patterns

Lokalise SDK Patterns

Overview

Production-ready patterns for Lokalise SDK usage in TypeScript and Node.js applications.

Prerequisites

• Completed lokalise-install-auth setup
• Familiarity with async/await and TypeScript
• Understanding of error handling best practices

Instructions

1. For full implementation details, load: Read(${CLAUDE_SKILL_DIR}/references/implementation-guide.md)

Output

• Type-safe client singleton with compression
• Robust error handling with retryable detection
• Rate-limited request queue
• Automatic retry with exponential backoff
• Cursor pagination for large datasets

Error Handling

Pattern	Use Case	Benefit
Safe wrapper	All API calls	Prevents uncaught exceptions
Request queue	Bulk operations	Respects rate limits
Retry logic	Transient failures	Improves reliability
Pagination	Large datasets	Memory efficient

Examples

Branch-Aware Client

export function getProjectWithBranch(projectId: string, branch?: string): string {
  // Lokalise branch syntax: projectId:branchName
  return branch ? `${projectId}:${branch}` : projectId;
}

// Usage
const projectId = getProjectWithBranch("123456.abcdef", "feature/new-ui");
const keys = await client.keys().list({ project_id: projectId });

Resources

• Node SDK Documentation
• Pagination Guide
• API Error Codes

Next Steps

Apply patterns in lokalise-core-workflow-a for real-world usage.