NGXF
  • 🚀Introduction
  • Get Started
    • Why
    • Installation
  • Concepts
    • Introduction
  • Features
    • Activated Route
    • Call
    • Init
    • Lazy
    • Keep Alive
    • Timeout
    • Track By Key
    • Repeat
    • Virtual Scroll
  • Server Interaction
    • Async
    • Cookies
    • Http
    • Socket.IO
  • Hooks
    • State Hook
    • Effect Hook
    • Reducer Hook
  • Recompose
    • Compose
  • API
    • NgxfModule
    • HttpDirective
    • RouteDirective
    • InitDirective
    • ComposeDirective
    • ReturnDirective
    • TimeoutDirective
    • CookiesDirective
    • AsyncDirective
    • LazyDirective
    • CallPipe
  • Recipes
    • Caching
    • Style Guide
  • Community
    • FAQ
    • Contributing
Powered by GitBook
On this page
  1. Get Started

Installation

Installation

To get started, install the package from npm. The latest version (6.x) supports Angular/RX 6.

npm i @ngxf/platform @ngxf/socket.io socket.io-client @types/socket.io-client --save
​
# or if you are using yarn
yarn add @ngxf/platform @ngxf/socket.io socket.io-client @types/socket.io-client

then in COMPONENT.module.ts, import the NgxfModule:

import { NgModule } from '@angular/core';
import { NgxfModule } from '@ngxf/platform';
import { NgxfSocketIOModule } from '@ngxf/socket.io';
​
@NgModule({
  imports: [
    NgxfModule,
    NgxfSocketIOModule
  ]
})
export class ComponentModule {}
PreviousWhyNextIntroduction

Last updated 6 years ago