vue-ts-ioc
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

vue-ts-ioc

VueJS bindings for IoC container and DI CircleCI

Dependencies

  • vue
  • vue-class-component
  • ts-ioc-di

Simple setup

import Vue from 'vue';
import { Plugin } from 'vue-ts-ioc';

Vue.use(Plugin);

new Vue({
 // Vue componentOptions here
});

Setup with manually instantiated container

import Vue from 'vue';
import { Plugin, Container } from 'vue-ts-ioc';

Vue.use(Plugin);

// ...

const container = new Container();

// bind things to container

new Vue({
 // Vue componentOptions here,
 container: container
});

Setup with a dedicated component

You can use one of your components just for container initialization

import Vue from 'vue';
import Component from 'vue-class-component';

import { Service, AnotherService } from 'somewhere';

@Component

export class ContainerInitialization extends Vue {
  public beforeCreate(): void {
    this.$container.alias(AnotherService, Service);
    this.$container.singleton(Service);
    this.$container.bindFactory(
      AnotherService, 
      (container: Container) => container.resolve(Service)
    );
  }
}

//  And then use it as a mixin in a root component

import Vue from 'vue';
import { Plugin } from 'vue-ts-ioc';

Vue.use(Plugin);

new Vue({
  mixins: [ContainerInitialization]
 // Vue componentOptions here
});

Setup with service providers

They are used to bind dependencies to container in two phases - registration and booting. In first phase you should not resolve any dependencies from container since they may have not been registered. In second phase you can resolve those dependencies and register another dependencies using them.

If you don't want to instantiate Application from package, you can use it as a mixin in your root component. There is only beforeCreate hook in it.

import Vue from 'vue';
import { Plugin } from 'vue-ts-ioc';

Vue.use(Plugin);

new Vue({
  mixins: [Application]
 // Vue componentOptions here
});
import Vue from 'vue';
import { Application, Plugin, Configuration, Provider } from 'vue-ts-ioc';

Vue.use(Plugin);

// ...

class ServiceProvider implements Provider {
  public register(container: Container): void {
    container.singleton(Service);
  }

  public boot(container: Container): void {
    container.resolve(AnotherService);
  }
}

// ...

new Application({
 // Vue componentOptions here,
 iocConfig: new Configuration(ServiceProvider, AnotherServiceProvider, ...)
});

Usage

All features except constructor injection are available.

// Somewhere in one of your components
import { Service } from 'somewhere';
import { Inject, InjectArgs } from 'vue-ts-ioc';

import Component from 'vue-class-component';

@Component
class TestComponent extends Vue {
  @Inject()
  private service?: Service;

  @InjectArgs()
  public beforeCreate(service: Service): void {
    // service is injected
  }
}

Package Sidebar

Install

npm i vue-ts-ioc

Weekly Downloads

1

Version

1.0.7

License

ISC

Unpacked Size

9.48 kB

Total Files

14

Last publish

Collaborators

  • realglebivanov