Type Alias: SurfaceVisibility

Makaio Framework

---

Makaio Framework / contracts/common / SurfaceVisibility

Type Alias: SurfaceVisibility

SurfaceVisibility = "all" | SurfaceType[]

Defined in: ../../../packages/contracts/src/common/surface.ts:42

Page surface visibility configuration.

Controls which rendering surfaces a page appears on:

• 'all': Available on every surface (default when omitted)
• SurfaceType[]: Restricted to listed surfaces only

Example

// Available everywhere
surfaces: 'all'

// Web and electron only
surfaces: ['web', 'electron']

// Mobile only
surfaces: ['mobile']

Type Composition

• SurfaceVisibility
  • 'all' | SurfaceType[]
    • 'all'
    • SurfaceType[]

Resolved Shape

type SurfaceVisibility = {
  toString: (() => string) | (() => string);
  concat: ((...strings: string[]) => string) | { (...items: Array<ConcatArray<import("@makaio/contracts").SurfaceType>>): Array<import("@makaio/contracts").SurfaceType>; (...items: Array<import("@makaio/contracts").SurfaceType | ConcatArray<import("@makaio/contracts").SurfaceType>>): Array<import("@makaio/contracts").SurfaceType>; };
  indexOf: ((searchString: string, position?: number) => number) | ((searchElement: import("@makaio/contracts").SurfaceType, fromIndex?: number) => number);
  lastIndexOf: ((searchString: string, position?: number) => number) | ((searchElement: import("@makaio/contracts").SurfaceType, fromIndex?: number) => number);
  slice: ((start?: number, end?: number) => string) | ((start?: number, end?: number) => Array<import("@makaio/contracts").SurfaceType>);
  length: number;
  valueOf: (() => string) | (() => Object);
  includes: ((searchString: string, position?: number) => boolean) | ((searchElement: import("@makaio/contracts").SurfaceType, fromIndex?: number) => boolean);
  at: ((index: number) => string | undefined) | ((index: number) => import("@makaio/contracts").SurfaceType | undefined);
  __@iterator@130715: (() => StringIterator<string>) | (() => ArrayIterator<import("@makaio/contracts").SurfaceType>);
  toLocaleString: (() => string) | { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string; };
};