Skyframe Documentation

Shell

Shell

What is it?

The Shell is the orchestrator object of the Skyframe web application. It provides several fundamental functions, such as the basic CRUD operations on Skyframe entities, triggering or registering use cases, within one single provider. It also holds the global context of the Skyframe web application (all about entities, registered use cases, etc.).

Using the Shell

The Shell provider is exported by the CoreModule. It is strongly recommended that you import the CoreModule into the global AppModule so you can inject it everywhere of your app:

@NgModule({
declarations: [AppComponent],
imports: [
...,
CoreModule,
...
],
entryComponents: [...],
providers: [],
exports: [],
bootstrap: [AppComponent]
})
export class AppModule {
...
}

Now you can inject it in any components:

@Component({
selector: 'my-component',
templateUrl: './my-component.html',
styleUrls: ['my-component.scss']
})
export class MyComponent {
constructor(private shell: Shell) {}
}

Also NgModules:

@NgModule({
...
})
export class MyModule {
constructor(private shell: Shell) {
// Use shell
}
}

On this page