README.md

VMST

About

This library implements a client to use VMST APIs

Import into other NestJS modules

Add the service to your module imports:

import { VMSTModule } from '@island.is/clients/vmst'

@Module({
  imports: [
    VMSTModule.register({
      xRoadBasePath: XROAD_BASE_PATH,
      xRoadClient: XROAD_CLIENT,
      apiKey: VMST_API_KEY,
    }),
  ],
})

Then you'll have access to VMST APIs:

import { UnionApi } from '@island.is/clients/vmst'

@Injectable()
export class SomeService {
  constructor(private unionApi: UnionApi) {}

  async getUnions(): Promise<Union[]> {
    const { unions } = await this.unionApi.unionGetUnions()

    if (unions) {
      return unions
    }

    // ....
  }
}

Code owners and maintainers

• Aranja