Class TypedSocketsPlugin<Schemes>

Type Parameters

Schemes extends BaseSchemes

Hierarchy

Scope<never, [Root<Schemes>]>
- TypedSocketsPlugin

Index

Constructors

constructor

new TypedSocketsPlugin<Schemes>(): TypedSocketsPlugin<Schemes>
Type Parameters
- Schemes extends BaseSchemes
Returns TypedSocketsPlugin<Schemes>
Overrides Scope<never, [Root<Schemes>]>.constructor
- Defined in src/lib/graph-editor/plugins/typed-sockets.ts:86

Properties

__scope

__scope: {
parents: [Root<Schemes>];
produces: never;
}

lastConnectionRemove

lastConnectionRemove: null | Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>> = null

name

name: string

`Optional`parent

parent?: any

signal

signal: Signal<any>

Methods

addPipe

addPipe(middleware): void
Parameters
- middleware: Pipe<Root<Schemes>>
Returns void
Inherited from Scope.addPipe
- Defined in node_modules/rete/_types/scope.d.ts:54

emit

emit<C>(context): Promise<undefined>
Type Parameters
- C extends never
Parameters
- context: C
Returns Promise<undefined>
Inherited from Scope.emit
- Defined in node_modules/rete/_types/scope.d.ts:59

getInputSocket

getInputSocket(nodeId, socketName): Socket<SocketType, "scalar" | "array">
Parameters
- nodeId: string
- socketName: string | number
Returns Socket<SocketType, "scalar" | "array">
- Defined in src/lib/graph-editor/plugins/typed-sockets.ts:153

getOutputSocket

getOutputSocket(nodeId, socketName): Socket<SocketType, "scalar" | "array">
Parameters
- nodeId: string
- socketName: string | number
Returns Socket<SocketType, "scalar" | "array">
- Defined in src/lib/graph-editor/plugins/typed-sockets.ts:157

hasParent

hasParent(): boolean
Returns boolean
Inherited from Scope.hasParent
- Defined in node_modules/rete/_types/scope.d.ts:60

parentScope

parentScope<T, P>(): Scope<T, P>
Type Parameters
- T extends Root<Schemes>
- P extends []
Returns Scope<T, P>
Inherited from Scope.parentScope
- Defined in node_modules/rete/_types/scope.d.ts:61
parentScope<T>(type): T
Type Parameters
- T
Parameters
- type: Type<T>
Returns T
Inherited from Scope.parentScope
- Defined in node_modules/rete/_types/scope.d.ts:62

setParent

setParent(scope): void
Parameters
- scope: Scope<Root<Schemes>, []>
Returns void
Overrides Scope.setParent
- Defined in src/lib/graph-editor/plugins/typed-sockets.ts:90

use

use<S>(scope): {
    debug<T>(_f: ((p: {
        [K in string | number | symbol]: Root<Schemes>
    }) => T)): void;
}
Type Parameters
- S extends Scope<any, any[]>
Parameters
- scope: NestedScope<S, [never, Root<Schemes>]>
Returns {
    debug<T>(_f: ((p: {
        [K in string | number | symbol]: Root<Schemes>
    }) => T)): void;
}
- debug:function
  - debug<T>(_f): void
  - Type Parameters
    - T extends []
    Parameters
    - _f: ((p: {
      [K in string | number | symbol]: Root<Schemes>
      }) => T)
      (p): T
      Parameters
      p: {
      [K in string | number | symbol]: Root<Schemes>
      }
      Returns T
    Returns void
    - Defined in node_modules/rete/_types/scope.d.ts:56
Inherited from Scope.use
- Defined in node_modules/rete/_types/scope.d.ts:55

Class TypedSocketsPlugin<Schemes>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns TypedSocketsPlugin<Schemes>

Properties

__scope

lastConnectionRemove

name

Optionalparent

signal

Methods

addPipe

Parameters

Returns void

emit

Type Parameters

Parameters

Returns Promise<undefined>

getInputSocket

Parameters

Returns Socket<SocketType, "scalar" | "array">

getOutputSocket

Parameters

Returns Socket<SocketType, "scalar" | "array">

hasParent

Returns boolean

parentScope

Type Parameters

Returns Scope<T, P>

Type Parameters

Parameters

Returns T

setParent

Parameters

Returns void

use

Type Parameters

Parameters

Returns { debug<T>(_f: ((p: { [K in string | number | symbol]: Root<Schemes> }) => T)): void; }

debug:function

Type Parameters

Parameters

Parameters

Returns T

Returns void

Settings

On This Page

`Optional`parent

Returns {
debug<T>(_f: ((p: {
[K in string | number | symbol]: Root<Schemes>
}) => T)): void;
}