collection-runtime

Interfaces

CollectionSurface

Defined in: packages/ui/build/collection-runtime/index.d.ts:4

Properties

representation?

readonly optional representation?: CollectionRepresentationSurface;

Defined in: packages/ui/build/collection-runtime/index.d.ts:5

CollectionSurfaceRuntime

Defined in: packages/ui/build/collection-runtime/index.d.ts:8

Properties

appId

readonly appId: () => string;

Defined in: packages/ui/build/collection-runtime/index.d.ts:9

Returns

string

surfaces

readonly surfaces: CollectionSurfaceRegistry;

Defined in: packages/ui/build/collection-runtime/index.d.ts:10

Methods

claimView()

claimView(view): () => void;

Defined in: packages/ui/build/collection-runtime/index.d.ts:11

Parameters

Parameter	Type
`view`	`string`

Returns

() => void

Type Aliases

CollectionRepresentationSurface

type CollectionRepresentationSurface = Component;

Defined in: packages/ui/build/collection-runtime/index.d.ts:3

CollectionSurfaceRegistry

type CollectionSurfaceRegistry = Readonly<Record<string, CollectionSurface>>;

Defined in: packages/ui/build/collection-runtime/index.d.ts:7

Functions

getCollectionClientContext()

function getCollectionClientContext(): CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>;

Defined in: packages/ui/build/collection-runtime/index.d.ts:13

Returns

CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>

getCollectionClientForSurface()

function getCollectionClientForSurface(candidate, surfaceName): CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>;

Defined in: packages/ui/build/collection-runtime/index.d.ts:16

Parameters

Parameter	Type
`candidate`	`object`
`surfaceName`	`string`

Returns

CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>

getCollectionSurfaceRuntime()

function getCollectionSurfaceRuntime(): 
  | CollectionSurfaceRuntime
  | undefined;

Defined in: packages/ui/build/collection-runtime/index.d.ts:20

Returns

| CollectionSurfaceRuntime | undefined

getOptionalCollectionClientContext()

function getOptionalCollectionClientContext(): 
  | CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>
  | undefined;

Defined in: packages/ui/build/collection-runtime/index.d.ts:14

Returns

| CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>> | undefined

resolveCollectionClient()

function resolveCollectionClient(candidate): 
  | CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>>
  | undefined;

Defined in: packages/ui/build/collection-runtime/index.d.ts:15

Parameters

Parameter	Type
`candidate`	`object`

Returns

| CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord>>>> | undefined

resolveCollectionSurface()

function resolveCollectionSurface(registry, collectionName): 
  | CollectionSurface
  | undefined;

Defined in: packages/ui/build/collection-runtime/index.d.ts:18

Parameters

Parameter	Type
`registry`	\| `Readonly`<`Record`<`string`, `CollectionSurface`>> \| `undefined`
`collectionName`	`string`

Returns

| CollectionSurface | undefined

setCollectionClientContext()

function setCollectionClientContext(context): void;

Defined in: packages/ui/build/collection-runtime/index.d.ts:17

Parameters

Parameter	Type
`context`	() => `CollectionClient`<`Readonly`<`Record`<`string`, `CollectionType`<`CollectionRecord`, `CollectionRecord`, `CollectionRecord`>>>>

Returns

void

setCollectionSurfaceRuntime()

function setCollectionSurfaceRuntime(runtime): void;

Defined in: packages/ui/build/collection-runtime/index.d.ts:19

Parameters

Parameter	Type
`runtime`	`CollectionSurfaceRuntime`

Returns

void