2.1.0 • Published 2 months ago

@farmfe/js-plugin-record-viewer v2.1.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 months ago

Record Viewer Plugin for Farm

Getting Started

To begin, you'll need to install @farmfe/js-plugin-record-viewer:

npm install @farmfe/js-plugin-record-viewer --save-dev

or

yarn add -D @farmfe/js-plugin-record-viewer

or

pnpm add -D @farmfe/js-plugin-record-viewer

Configuring the plugin in farm.config.ts:

import { defineFarmConfig } from '@farmfe/core/dist/config';
import record from '@farmfe/js-plugin-record-viewer'; //  import the plugin

export default defineFarmConfig({
  compilation: {
    input: {
      index: './index.html'
    },
    output: {
      path: './build'
    }
  },
  plugins: [
    // use the record viewer plugin.
    record({
      // custom options here
    })
  ]
});

Options

RecordViewerOptions

Type:

type RecordViewerOptions = {
  /**
   * Specify hostname
   * @default '127.0.0.1'
   */
  host?: string;

  /**
   * Specify port
   * @default 9527
   */
  port?: number;
}

Default: undefined