Interface: DataProcessors

The data processors that registered with Lynx.registerDataProcessors.

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;
    }
  }
})

Indexable

[processorName: string]: (...args: any[]) => any

Methods

getScreenMetricsOverride()?

optional getScreenMetricsOverride(metrics: object): object

Optional processor to override screen metrics used by the app

Parameters

Parameter	Type	Description
`metrics`	`object`	The physical screen dimensions in pixels
`metrics.height`	`number`	The physical pixel height of the screen
`metrics.width`	`number`	The physical pixel width of the screen

Returns

object

New screen dimensions to be used by the app

height

height: number;

width

width: number;

Example

lynx.registerDataProcessors({
  dataProcessors: {
    getScreenMetricsOverride: (metrics) => {
      // Force a specific aspect ratio
      return {
        width: metrics.width,
        height: metrics.width * (16/9)
      };
    }
  }
});

Defined in

@lynx-js/react/runtime/lib/lynx-api.d.ts:212

#Interface: DataProcessors

#Example

#Indexable

#Methods

#getScreenMetricsOverride()?

#Parameters

#Returns

#height

#width

#Example

#Defined in

Interface: DataProcessors

Example

Indexable

Methods

getScreenMetricsOverride()?

Parameters

Returns

height

width

Example

Defined in