@decoraxios/awe-axios-core 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 SWUST-LMH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # @decoraxios/awe-axios-core
2
+
3
+ Decorator-first HTTP primitives for `awe-axios`.
4
+
5
+ `@decoraxios/awe-axios-core` provides the base request decorators, parameter decorators, runtime plugins, and TypeScript-first `ApiCall<T>` signatures.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install @decoraxios/awe-axios-core axios
11
+ ```
12
+
13
+ ## Highlights
14
+
15
+ - Decorator-based HTTP client declarations
16
+ - Strong TypeScript return types
17
+ - Request strategy decorators such as `@Retry`, `@Debounce`, and `@Throttle`
18
+ - Custom axios instance binding and request/response transforms
19
+
20
+ ## Quick Example
21
+
22
+ ```ts
23
+ import { type ApiCall, Get, HttpApi, PathParam } from '@decoraxios/awe-axios-core';
24
+
25
+ @HttpApi('https://api.example.com/users')
26
+ class UserApi {
27
+ @Get('/:id')
28
+ getUser(@PathParam('id') id: string): ApiCall<{ id: string; name: string }> {
29
+ return undefined as never;
30
+ }
31
+ }
32
+ ```
33
+
34
+ More documentation:
35
+
36
+ - English: <https://github.com/bloom-lmh/awe-axios#readme>
37
+ - 中文: <https://github.com/bloom-lmh/awe-axios/blob/master/README_CH.md>