Node API

defineKit

• Type: (options: KitOptions) => Kit
• Description: Declare the suite to register custom commands and GUI's local communication service, etc.
• Example:

  import { defineKit, useServerSocket, type Kit } from 'revili/node'
  
  const demoKit: Kit = defineKit({
    // The name of the kit
    name: 'revili-kit-demo',
  
    // The GUI client development framework, default vue, and will expand react, servlet, web component, etc.
    webFramework: 'vue'
  
    // Refer to https://vitejs.dev/config/
    viteOptions: {}
  
    // Register for services that can communicate with GUI
    registerService(server) {
      // ...
    },
  
    // Register the command
    registerCommand({ program }) {
      program.command('test').action(() => {
        console.log('You triggered the test command!！')
      })
    },
  })
  
  export default demoKit
  

KitOptions

interface KitOptions {
  name: string
  webFramework?: 'vue'
  viteOptions?: UserConfig
  registerService?: (server: ViteDevServer) => void
  registerCommand: (params: {program: CAC; reviliConfig?: ReviliConfig}) => void
}

useServerSocket

• Type: (server: ViteDevServer) => WebSocketServer | null
• Description: The server communicates with the client.
• Example:

  import {defineKit, useServerSocket, type Kit} from 'revili/node'
  
  const demoKit: Kit = defineKit({
    name: 'revili-kit-demo',
  
    registerService(server) {
      const socket = useServerSocket(server)
  
      socket?.on('event-name', (data: any) => {
        // ...
      })
  
      socket?.send('event-name', 'message')
    }
  })
  
  export default demoKit