@devup-api/core
Advanced tools
+1
-1
| { | ||
| "name": "@devup-api/core", | ||
| "version": "0.1.2", | ||
| "version": "0.1.3", | ||
| "license": "Apache-2.0", | ||
@@ -5,0 +5,0 @@ "type": "module", |
+33
-4
| # @devup-api/core | ||
| Core package for devup API | ||
| Core types and interfaces for devup-api. | ||
@@ -11,9 +11,38 @@ ## Installation | ||
| ## Exports | ||
| ### Types | ||
| - `DevupApiOptions` - Plugin configuration options | ||
| - `DevupApiTypeGeneratorOptions` - Type generation options | ||
| - `UrlMapValue` - URL map entry structure | ||
| - `DevupApiStruct` - API structure types for type-safe API calls | ||
| ### Interfaces | ||
| ```ts | ||
| interface DevupApiOptions { | ||
| openapiFile?: string | ||
| tempDir?: string | ||
| convertCase?: 'snake' | 'camel' | 'pascal' | 'maintain' | ||
| requestDefaultNonNullable?: boolean | ||
| responseDefaultNonNullable?: boolean | ||
| } | ||
| interface UrlMapValue { | ||
| method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | ||
| url: string | ||
| } | ||
| ``` | ||
| ## Usage | ||
| ```typescript | ||
| import { devupApi } from '@devup-api/core'; | ||
| This package is primarily used internally by other devup-api packages. You typically don't need to import from this package directly unless you're building custom integrations. | ||
| const core = devupApi("https://example.com"); | ||
| ```ts | ||
| import type { DevupApiOptions } from '@devup-api/core' | ||
| ``` | ||
| ## License | ||
| Apache 2.0 |
7217
11.44%48
152.63%