Frequently Asked Questions#

General Questions#

What is the Asterisms JS SDK?#

The Asterisms JS SDK is a TypeScript-first browser SDK that provides a unified interface for interacting with Asterisms platform services including authentication, data storage, file management, and more.

What platforms does the SDK support?#

The SDK is designed for browser environments and supports:

• Modern browsers (Chrome, Firefox, Safari, Edge)
• SvelteKit applications
• React applications
• Vanilla JavaScript/TypeScript projects

Is the SDK free to use?#

Please refer to your Asterisms platform documentation for licensing and usage terms.

Installation & Setup#

How do I install the SDK?#

npm install @asterisms/sdk

What are the minimum requirements?#

• Node.js 16+ for development
• Modern browser with ES2020 support
• TypeScript 4.7+ (recommended)

Authentication#

How do I authenticate users?#

The SDK supports multiple authentication methods:

• OAuth 2.0 / OpenID Connect
• SRP6 authentication
• Custom authentication providers

See the Authentication Guide for detailed examples.

How do I handle token refresh?#

The SDK automatically handles token refresh when configured with appropriate credentials. See the configuration section for details.

Development#

How do I enable debug logging?#

import { createAsterismsClient } from '@asterisms/sdk';

const client = createAsterismsClient({
  // ... other config
  logging: {
    level: 'debug'
  }
});

Where can I find more examples?#

Check out the Examples section for framework-specific implementations and common use cases.

Troubleshooting#

I'm getting TypeScript errors#

Make sure you're using TypeScript 4.7+ and have the latest SDK version. The SDK provides full TypeScript support with detailed type definitions.

API calls are failing#

1. Check your authentication configuration
2. Verify your base URL and endpoints
3. Check browser console for detailed error messages
4. Review the Troubleshooting Guide

Performance issues#

The SDK is optimized for performance, but you can:

• Use proper pagination for large datasets
• Implement caching strategies
• Review your polling intervals

Contributing#

How can I contribute to the SDK?#

Please refer to the project's contribution guidelines in the main repository.

How do I report bugs?#

Use the issue tracker in the main repository with detailed reproduction steps and environment information.

Getting Help#

Where can I get support?#

• Check this FAQ and documentation first
• Review the Troubleshooting Guide
• Contact your Asterisms platform support team

How do I stay updated?#

• Watch the repository for releases
• Check the Migration Guide for breaking changes
• Review release notes for new features