index
Classes
Section titled “Classes”| Class | Description |
|---|---|
| AuthenticationError | Authentication error (401) - Missing or invalid token |
| AuthorizationError | Authorization error (403) - Insufficient permissions |
| ChanomhubError | Base error class for all SDK errors |
| NetworkError | Network error - Fetch failures, timeouts, etc. |
| NotFoundError | Not found error (404) - Resource doesn’t exist |
| RateLimitError | Rate limit error (429) - Too many requests |
| ValidationError | Validation error (400) - Invalid request data |
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| Article | Full Article type |
| ArticleFilter | Article filter options |
| ArticleListItem | Partial article for list views |
| ArticleListOptions | Article list options |
| ArticleWithDownloads | Article with downloads response |
| Author | Author type |
| AuthSession | Auth session state |
| ChanomhubClient | Chanomhub SDK Client interface |
| ChanomhubConfig | Chanomhub SDK Configuration |
| Download | Download link type |
| GraphQLResponse | GraphQL response wrapper |
| ImageObject | Image object |
| ListOptions | Pagination options |
| LoginResponse | Login response from backend after token exchange |
| LoginSupabaseRequest | Backend login request |
| Mod | Mod type |
| NamedEntity | Named entity (tag, category, platform, etc.) |
| NativeOAuthConfig | Native OAuth provider configuration for React Native |
| NativeOAuthOptions | Options for native OAuth sign-in |
| NativeOAuthResult | Native OAuth authorization result from react-native-app-auth |
| OAuthOptions | OAuth redirect options |
| OfficialDownloadSource | Official download source |
| PaginatedResponse | Paginated response wrapper |
| Profile | Public profile |
| ProfileResponse | Profile response wrapper |
| RefreshResponse | Token refresh response from backend |
| RefreshTokenRequest | Backend refresh token request |
| SupabaseSession | Supabase session (minimal type for SDK use) |
| User | Current logged-in user |
| UserResponse | User response wrapper |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| ArticleField | Available fields for custom selection |
| ArticlePreset | Field preset levels for article queries - minimal: Basic info only (id, title, slug, mainImage) - best for cards/thumbnails - standard: Common fields for list views (default) - full: All available fields including body content |
| ArticleStatus | Article status enum |
| GameEngine | Game engine enum |
| OAuthProvider | Supported OAuth providers |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| DEFAULT_CONFIG | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| createAuthenticatedClient | Creates a client with authentication token Convenience function for authenticated requests |
| createChanomhubClient | Creates a Chanomhub API client |
| createErrorFromStatus | Creates the appropriate error class based on HTTP status code |
| resolveImageUrl | Resolves an image URL. - If it’s just a filename (e.g., “abc.jpg”), prepends the CDN base URL - If it’s already a full URL, returns it as-is - Handles null/undefined gracefully |
References
Section titled “References”default
Section titled “default”Renames and re-exports createChanomhubClient