ApiLibrary

ApiLibrary is an Angular library designed to simplify API interactions in Angular applications. It was generated with Angular CLI version 18.2.0.

Features

• Streamlined HTTP request handling
• Built-in error handling and logging
• Customizable request interceptors
• Automatic retry mechanism for failed requests
• Caching support for improved performance

Installation

To install ApiLibrary in your project, run:

npm install api-library

Usage

Here's a basic example of how to use ApiLibrary:

import { ApiService } from "api-library";

@Component({
  // ...
})
export class MyComponent {
  constructor(private apiService: ApiService) {}

  fetchData() {
    this.apiService.get("https://api.example.com/data").subscribe(
      (response) => console.log(response),
      (error) => console.error("An error occurred:", error)
    );
  }
}

Error Handling

ApiLibrary includes a global error handling mechanism. To use it, configure it in your app.config.ts:

import { ApplicationConfig, provideZoneChangeDetection } from "@angular/core";
import { provideRouter } from "@angular/router";

import { routes } from "./app.routes";
import { provideHttpClient, withInterceptors } from "@angular/common/http";
import { errorInterceptor } from "@tagangular/api-library";

export const appConfig: ApplicationConfig = {
  providers: [..., provideHttpClient(withInterceptors([errorInterceptor]))],
};

Development

Code scaffolding

Run ng generate component component-name --project api-library to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project api-library.

Note: Don't forget to add --project api-library or else it will be added to the default project in your angular.json file.

Build

Run ng build api-library to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build api-library, go to the dist folder cd dist/api-library and run npm publish.

Running unit tests

Run ng test api-library to execute the unit tests via Karma.

Contributing

We welcome contributions to ApiLibrary! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

License

ApiLibrary is MIT licensed. See the LICENSE file for details.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Tags

#angular #api #http #typescript #library