svrx
  • Languages
  • svrx
  • svrx
    • SUMMARY
    • Contributing to svrx
    • Getting Started
    • Blog
      • Server-X: A Pluggable Platform For Local Frontend Development
    • Guide
      • API Reference
      • Option Reference
      • How To Use Routes
    • Plugins
      • How To Write A Plugin
      • How To Use Plugins
    • Practice
      • Integrations
      • Recipes
  • svrx
    • 概要
    • 贡献指南
    • 快速上手
    • Blog
      • Server-X:一款可能提升你十倍工作效率的工具
      • 使用 svrx 实现更优雅的接口 Mock
      • 说说 Server-X 的免安装插件机制
    • 进阶指南
      • API 索引
      • 参数列表
      • Routing 路由的使用
    • 插件体系
      • 如何写一个插件
      • 插件的使用
    • 项目实战
      • 结合主流脚手架使用
      • 特定场景使用
Powered by GitBook
On this page
  • svrx(option)
  • server.start()
  • server.close()
  • server.reload()
  • server.on
  • builtin events
  • server.off
  • server.emit

Was this helpful?

  1. svrx
  2. Guide

API Reference

PreviousGuideNextOption Reference

Last updated 3 years ago

Was this helpful?

svrx(option)

Get the instance of Svrx

Usage

const svrx = require('@svrx/svrx');

const server = svrx({
  port: 8002
});

Param

  • option:

Return

the instance of Svrx

server.start()

Start svrx

Usage

server.start().then(port => {
  console.log(port);
});

Return

Promise

server.close()

Usage

server.close().then(() => {
  console.log('Svrx has closed');
});

Param

Return

Promise

server.reload()

Manually refresh the browser

Usage

server.reload();

server.on

Attach event listener

builtin events

1. ready

Emit when svrx start

server.on('ready', port => {});

2. plugin

server.on('plugin', async ({io, events, config, router, injector, logger, middleware }=>{
    // you logic here
}))

3. file:change

emit after file change (make sure that livereload is enable)

server.off

unbind specific event

server.on('file:change', handler);
server.off('file:change', handler);

server.emit

server.emit('custom-event', { param1: 1 });

Emit after plugin building, as same as hook.onCreate, see for more details

see option reference
How to create plugin