baasic-sdk-angular
TypeScript icon, indicating that this package has built-in type declarations

2.0.0-beta03 • Public • Published

Baasic Angular SDK

Baasic Angular library provides integration access to Baasic REST API end-points.

Architecture

With this release, we moved away from Gulp to even more popular WebPack bundler, while keeping all Baasic modules inside one Git repository. Angular SDK automatically handles Baasic token storage and similar features.

Since Angular SDK depends on Baasic JavaScript SDK, which is built using TypeScript, it gives us a strongly-typed way of using Angular SDK. Using TypeScript, the inheritance of any Baasic model can be extended - all you need to do is add your properties and save the model using Angular service.

Setup

To properly configure your solution for using Angular SDK, you will need to add the following line to your package.config file by executing:

npm install baasic-sdk-angular --save

Initialization

To be able to use the library, add Baasic (BaasicApp) dependency to your Angular module:

import { BaasicApp } from 'baasic-sdk-angular';

Application Configuration

Baasic Angular SDK library allows you to use a single Baasic application in your Angular modules. To initialize an application, add the following code to your module configuration:

@NgModule({
  ...,
  imports: [ 
    ...,
    BaasicApp.forRoot('<api-key>', {
            apiRootUrl: "api.baasic.com",
            apiVersion: "<version>"      
    })
  ],
  ...
})
 

Usage

In order to use any of the Baasic Angular SDK services, you need to inject them into your service as follows:

import { Injectable } from '@angular/core';
import {
    MembershipService,
    IOptions,
    IHttpResponse,
    IBaasicQueryModel,
    IRole
} from 'baasic-sdk-angular';
 
@Injectable()
export class RoleService {
 
    constructor(private membershipService: MembershipService) { }
 
    async getAll(): Promise<IBaasicQueryModel<IRole>> {
        var result = await this.membershipService.role.find();
 
        return Promise.resolve(result.data);
    }
}

Other

To get more information about the configuration, please visit Baasic Developer Center .

  • Help us write the documentation
  • Create interesting apps using SDK
  • Looking for something else to do? Get in touch ...

Package Sidebar

Install

npm i baasic-sdk-angular

Weekly Downloads

1

Version

2.0.0-beta03

License

MIT

Unpacked Size

802 kB

Total Files

350

Last publish

Collaborators

  • baasic