• English

      • Home > @lynx-js/react > DataProcessors

      DataProcessors interface

      The data processors that registered with Lynx.registerDataProcessors.

      Signature:

      export interface DataProcessors

      Example

      Extending dataProcessors interface

      import type { DataProcessors as WellKnownDataProcessors } from '@lynx-js/react';

declare module '@lynx-js/react' {
  interface DataProcessors extends WellKnownDataProcessors {
    foo(bar: string): number;
  }
}

      Then you can use lynx.registerDataProcessors with types.

      lynx.registerDataProcessors({
  dataProcessors: {
    foo(bar) {
      return 1;
    }
  }
})

      Methods

      MethodDescription
      getScreenMetricsOverride(metrics)?(Optional) Optional processor to override screen metrics used by the app