Notable Peru Mariachis

    @veeroute/lss-delivery-angular
    TypeScript icon, indicating that this package has built-in type declarations

    3.15.183137 • Public • Published

    @veeroute/lss-delivery-angular@3.15.183137

    General usage

    In your Angular project:

    // without configuring providers
    import { LssDeliveryApiModule } from '@veeroute/lss-delivery-angular';
    import { HttpClientModule } from '@angular/common/http';
    
    @NgModule({
        imports: [
            LssDeliveryApiModule,
            // make sure to import the HttpClientModule in the AppModule only,
            // see https://github.com/angular/angular/issues/20575
            HttpClientModule
        ],
        declarations: [ AppComponent ],
        providers: [],
        bootstrap: [ AppComponent ]
    })
    export class AppModule {}
    
    // configuring providers
    import { LssDeliveryApiModule, Configuration, ConfigurationParameters } from '@veeroute/lss-delivery-angular';
    
    export function apiConfigFactory (): Configuration {
      const params: ConfigurationParameters = {
        // set configuration parameters here.
      }
      return new Configuration(params);
    }
    
    @NgModule({
        imports: [ LssDeliveryApiModule.forRoot(apiConfigFactory) ],
        declarations: [ AppComponent ],
        providers: [],
        bootstrap: [ AppComponent ]
    })
    export class AppModule {}
    
    // configuring providers with an authentication service that manages your access tokens
    import { LssDeliveryApiModule, Configuration } from '@veeroute/lss-delivery-angular';
    
    @NgModule({
        imports: [ LssDeliveryApiModule ],
        declarations: [ AppComponent ],
        providers: [
          {
            provide: Configuration,
            useFactory: (authService: AuthService) => new Configuration(
              {
                basePath: environment.apiUrl,
                accessToken: authService.getAccessToken.bind(authService)
              }
            ),
            deps: [AuthService],
            multi: false
          }
        ],
        bootstrap: [ AppComponent ]
    })
    export class AppModule {}
    
    import { DefaultApi } from '@veeroute/lss-delivery-angular';
    
    export class AppComponent {
        constructor(private apiGateway: DefaultApi) { }
    }
    

    Note: The LssDeliveryApiModule is restricted to being instantiated once app wide. This is to ensure that all services are treated as singletons.

    Using multiple OpenAPI files / APIs / LssDeliveryApiModules

    In order to use multiple LssDeliveryApiModules generated from different OpenAPI files, you can create an alias name when importing the modules in order to avoid naming conflicts:

    import { LssDeliveryApiModule } from 'my-api-path';
    import { LssDeliveryApiModule as OtherApiModule } from 'my-other-api-path';
    import { HttpClientModule } from '@angular/common/http';
    
    @NgModule({
      imports: [
        LssDeliveryApiModule,
        OtherApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule
      ]
    })
    export class AppModule {
    
    }
    

    Set service base path

    If different than the generated base path, during app bootstrap, you can provide the base path to your service.

    import { BASE_PATH } from '@veeroute/lss-delivery-angular';
    
    bootstrap(AppComponent, [
        { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
    ]);
    

    or

    import { BASE_PATH } from '@veeroute/lss-delivery-angular';
    
    @NgModule({
        imports: [],
        declarations: [ AppComponent ],
        providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
        bootstrap: [ AppComponent ]
    })
    export class AppModule {}
    

    Using @angular/cli

    First extend your src/environments/*.ts files by adding the corresponding base path:

    export const environment = {
      production: false,
      API_BASE_PATH: 'http://127.0.0.1:8080'
    };
    

    In the src/app/app.module.ts:

    import { BASE_PATH } from '@veeroute/lss-delivery-angular';
    import { environment } from '../environments/environment';
    
    @NgModule({
      declarations: [
        AppComponent
      ],
      imports: [ ],
      providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
      bootstrap: [ AppComponent ]
    })
    export class AppModule { }
    

    Install

    npm i @veeroute/lss-delivery-angular

    DownloadsWeekly Downloads

    1

    Version

    3.15.183137

    License

    MIT

    Unpacked Size

    1.01 MB

    Total Files

    209

    Last publish

    Collaborators

    • veeroute.vk
    • darthwelder