SROQueue | Winter Cardinal

A synchronized read-only queue.

Type parameters

V

a value type

Hierarchy

SContainer<SQueueData<V>, SQueuePatch<V>, SQueuePatches<V>, SQueueMemory<V>>
- SROQueue
  - SQueue

Index

Methods

Constructors

constructor

new SROQueue(memory: SQueueMemory<V>): SROQueue

Overrides SContainer.constructor
- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:39
Parameters
- memory: SQueueMemory<V>
Returns SROQueue

Events

change

onchange(event: Event, addedItems: AddedQueueItems<V>, removedItems: RemovedQueueItems<V>): void

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:230
Triggered when a queue is changed.
```
on( "change", ( event, addedItems, removedItems ) => {
    // DO SOMETHING HERE
})
```
Parameters
- event: Event
  
  event object.
- addedItems: AddedQueueItems<V>
  
  enqueued items sorted by their enqueue timing in ascending order
- removedItems: RemovedQueueItems<V>
  
  dequeued items sorted by their dequeue timing in ascending order
Returns void

value

onvalue(event: Event, addedItems: AddedQueueItems<V>, removedItems: RemovedQueueItems<V>): void

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:216
Triggered when a queue is initialized or changed. If a queue is initialized when event handlers are set, event handlers are invoked immediately.
```
on( "value", ( event, addedItems, removedItems ) => {
    // DO SOMETHING HERE
})
```
Parameters
- event: Event
  
  an event object
- addedItems: AddedQueueItems<V>
  
  enqueued items sorted by their enqueue timing in ascending order
- removedItems: RemovedQueueItems<V>
  
  dequeued items sorted by their dequeue timing in ascending order
Returns void

Properties

Protected mem

__mem__: SQueueMemory<V>

Methods

connector

connector(): Connector

Inherited from Connectable.connector
- Defined in src/main/typescript/wcardinal/event/connectable.ts:23
Returns Connector

contains

contains(element: unknown, comparator?: Comparator, thisArg?: unknown): boolean

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:165
Returns true if this queue contains the specified value.

Parameters
- element: unknown
  
  value to search for
- Default value comparator: Comparator = defaultComparator
  
  comparator
- Default value thisArg: unknown = this
  
  context of the comparator
Returns boolean

true if this queue contains the specified value

containsAll

containsAll(elements: ArrayLike<unknown>, comparator?: Comparator, thisArg?: unknown): boolean

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:177
Returns true if this queue contains all the specified values.

Parameters
- elements: ArrayLike<unknown>
  
  values to search for
- Default value comparator: Comparator = defaultComparator
  
  comparator
- Default value thisArg: unknown = this
  
  context of the comparator
Returns boolean

true if this queue contains all the specified values

each

each(iteratee: Iteratee<number, V | null, this>, thisArg?: unknown, reverse?: boolean): this

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:115
Iterates over elements of this queue, calling the iteratee for each element. The iteratee is bound to the thisArg and invoked with three arguments: value, key, this queue. The iteratee may exit iteration early by explicitly returning false.

Parameters
- iteratee: Iteratee<number, V | null, this>
  
  the function called per iteration
- Default value thisArg: unknown = this
  
  the this binding of the iteratee
- Default value reverse: boolean = false
  
  true to iterate in the reverse order
Returns this

this

element

element(): V | null

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:74
Returns the head of this queue, or returns null if this queue is empty.

Returns V | null

the head of this queue, or returns null if this queue is empty

find

find(predicate: Iteratee<number, V | null, this>, thisArg?: unknown, reverse?: boolean): unknown

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:129
Returns the first element which the specified predicate returns true, or null if there is no such element. The predicate is bound to the thisArg and invoked with three arguments: element, index and this instance.

Parameters
- predicate: Iteratee<number, V | null, this>
  
  the function called per iteration
- Default value thisArg: unknown = this
  
  the this binding of the predicate
- Default value reverse: boolean = false
  
  true to iterate in the reverse order
Returns unknown

the first element which the predicate returns true, or null if there is no such element

get

get(index: number): V | null

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:65
Returns an element at the specified index.

throws

Error if the index is out of bounds (index < 0 || size() <= index)

Parameters
- index: number
  
  an index of the element
Returns V | null

the element at the specified index

getCapacity

getCapacity(): number

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:49
Returns the capacity.

Returns number

the capacity

indexOf

indexOf(element: unknown, comparator?: Comparator, thisArg?: unknown): number

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:141
Returns the index of the specified value.

Parameters
- element: unknown
  
  value to search for
- Default value comparator: Comparator = defaultComparator
  
  comparator
- Default value thisArg: unknown = this
  
  context of the comparator
Returns number

the index of the specified value or -1 if this queue does not contain the specified value

initialize

initialize(): this

Inherited from SContainer.initialize
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:54
Returns this

isEmpty

isEmpty(): boolean

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:101
Returns true if this queue is empty.

Returns boolean

true if this queue is empty

isInitialized

isInitialized(): boolean

Inherited from SContainer.isInitialized
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:50
Returns true if this is initialized.

Returns boolean

true if this is initialized.

isLocked

isLocked(): boolean

Inherited from SContainer.isLocked
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:74
Returns true if this data is locked.

Returns boolean

true if this data is locked

isNonNull

isNonNull(): boolean

Inherited from SContainer.isNonNull
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:36
Returns true if this is non-null.

Returns boolean

true if this is non-null.

isReadOnly

isReadOnly(): boolean

Inherited from SContainer.isReadOnly
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:27
Returns true if this is read-only.

Returns boolean

true if this is read-only

lastIndexOf

lastIndexOf(element: unknown, comparator?: Comparator, thisArg?: unknown): number

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:153
Returns the last index of the specified value.

Parameters
- element: unknown
  
  value to search for
- Default value comparator: Comparator = defaultComparator
  
  comparator
- Default value thisArg: unknown = this
  
  context of the comparator
Returns number

the last index of the specified value or -1 if this queue does not contain the specified value

lock

lock(): this

Inherited from SContainer.lock
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:64
Locks this data.

Returns this

this

off

off(types: string, handler?: Function): this
off(target: unknown, types: string, handler?: Function): this

Unregister the event handlers of the specified events.

off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );

Parameters

types: string

space-separated event types
Optional handler: Function

the event handler to be unregistered

Returns this

this

Inherited from Connectable.off
- Defined in src/main/typescript/wcardinal/event/connectable.ts:261
Unregister the event handlers of the specified events.
```
off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );
```
Parameters
- target: unknown
  
  event target
- types: string
  
  space-separated event types
- Optional handler: Function
  
  the event handler to be unregistered
Returns this

this

offoff

offoff(types: string, handler?: OnoffHandler): this

Inherited from Connectable.offoff
- Defined in src/main/typescript/wcardinal/event/connectable.ts:99
Unregisters the event handler for the unregistration events of the specified events.
```
onoff("eventname", handler);
```
Parameters
- types: string
  
  space-separated event names
- Optional handler: OnoffHandler
  
  an event handler
Returns this

this

offon

offon(types: string, handler?: OnonHandler): this

Inherited from Connectable.offon
- Defined in src/main/typescript/wcardinal/event/connectable.ts:85
Unregisters the event handlers for the registration events of the specified events.
```
offon("eventname", handler);
```
Parameters
- types: string
  
  space-separated event types
- Optional handler: OnonHandler
  
  an event handler
Returns this

this

on

on(types: string, handler: Function): this
on(target: unknown, types: string, handler: Function): this

Inherited from Connectable.on
- Defined in src/main/typescript/wcardinal/event/connectable.ts:127
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );
```
Parameters
- types: string
  
  space-separated event types
- handler: Function
  
  the event handler to be registered
Returns this

this
Inherited from Connectable.on
- Defined in src/main/typescript/wcardinal/event/connectable.ts:153
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );
```
Parameters
- target: unknown
  
  event target or event types
- types: string
  
  space-separated event types
- handler: Function
  
  the event handler to be registered
Returns this

this

one

one(types: string, handler: Function): this
one(target: unknown, types: string, handler: Function): this

Inherited from Connectable.one
- Defined in src/main/typescript/wcardinal/event/connectable.ts:186
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );
```
Parameters
- types: string
  
  space-separated event types
- handler: Function
  
  The event handler to be registered
Returns this

this
Inherited from Connectable.one
- Defined in src/main/typescript/wcardinal/event/connectable.ts:210
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );
```
Parameters
- target: unknown
  
  event target
- types: string
  
  space-separated event types
- handler: Function
  
  The event handler to be registered
Returns this

this

onoff

onoff(types: string, handler: OnoffHandler): this

Inherited from Connectable.onoff
- Defined in src/main/typescript/wcardinal/event/connectable.ts:71
Registers the event handler for the unregistration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are unregistered. The latter boolean gets true if this is the last handler of the event identified by Connection.type.
```
onoff("eventname", function( connection, isLast ){
    // DO SOMETHING HERE
});
```
Parameters
- types: string
  
  space-separated event names
- handler: OnoffHandler
  
  an event handler
Returns this

this

onon

onon(types: string, handler: OnonHandler): this

Inherited from Connectable.onon
- Defined in src/main/typescript/wcardinal/event/connectable.ts:51
Registers the event handler for the registration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are registered. The latter boolean gets true if this is the first handler of the event identified by Connection.type.
```
onon("eventname", function( connection, isFirst ){
    if( some-condition ) {
        connection.trigger( this, null, [ first-event-parameter, second-event-parameter, ... ] );
    }
});
```
Parameters
- types: string
  
  space-separated event types
- handler: OnonHandler
  
  an event handler
Returns this

this

peek

peek(): V | null

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:83
Returns the head of this queue, or returns null if this queue is empty.

Returns V | null

the head of this queue, or returns null if this queue is empty

retrigger

retrigger(originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]
retrigger(target: Node | null, originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]

Inherited from Connectable.retrigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:380
Invokes all the handlers of the specified event.
```
retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );
```
Parameters
- originalEvent: OriginalEvent
  
  the event object
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
Returns unknown[]

the returned values of the invoked handlers
Inherited from Connectable.retrigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:404
Invokes all the handlers of the specified event.
```
retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );
```
Parameters
- target: Node | null
  
  event target
- originalEvent: OriginalEvent
  
  the event object
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers

size

size(): number

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:92
Returns the size.

Returns number

the size

toArray

toArray(): Array<V | null>

- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:190
Returns the array representing this queue. Must not change the returned array.

Returns Array<V | null>

the array representing this queue

toJson

toJson(): Array<V | null>

Overrides SContainer.toJson
- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:194
Returns Array<V | null>

toString

toString(): string

Overrides SContainer.toString
- Defined in src/main/typescript/wcardinal/controller/data/s-ro-queue.ts:198
Returns string

trigger

trigger(types: string, parameters?: unknown[]): unknown[]
trigger(target: Node | null, types: string, parameters?: unknown[]): unknown[]

Inherited from Connectable.trigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:298
Invokes all the handlers of the specified event.
```
trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );
```
Parameters
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers
Inherited from Connectable.trigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:319
Invokes all the handlers of the specified event.
```
trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );
```
Parameters
- target: Node | null
  
  Event target
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers

triggerDirect

triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: null): null
triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: unknown[]): unknown[]

Inherited from Connectable.triggerDirect
- Defined in src/main/typescript/wcardinal/event/connectable.ts:349
Parameters
- name: string
- type: string[] | null
- args: unknown[] | null
- results: null
Returns null
Inherited from Connectable.triggerDirect
- Defined in src/main/typescript/wcardinal/event/connectable.ts:352
Parameters
- name: string
- type: string[] | null
- args: unknown[] | null
- results: unknown[]
Returns unknown[]

uninitialize

uninitialize(): this

Inherited from SContainer.uninitialize
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:40
Returns this

unlock

unlock(): this

Inherited from SContainer.unlock
- Defined in src/main/typescript/wcardinal/controller/data/internal/s-container.ts:83
Unlocks this data.

Returns this

this

Static extend

extend<T>(target: T): T & Connectable

Inherited from Connectable.extend
- Defined in src/main/typescript/wcardinal/event/connectable.ts:450
Extends the specified target with the Connectable methods.

Type parameters
- T
Parameters
- target: T
  
  non-null target to be extended
Returns T & Connectable

the specified target

Type parameters

V

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Parameters

memory: SQueueMemory<V>

Returns SROQueue

Events

change

Parameters

event: Event

addedItems: AddedQueueItems<V>

removedItems: RemovedQueueItems<V>

Returns void

value

Parameters

event: Event

addedItems: AddedQueueItems<V>

removedItems: RemovedQueueItems<V>

Returns void

Properties

Protected __mem__

Methods

connector

Returns Connector

contains

Parameters

element: unknown

Default value comparator: Comparator = defaultComparator

Default value thisArg: unknown = this

Returns boolean

containsAll

Parameters

elements: ArrayLike<unknown>

Default value comparator: Comparator = defaultComparator

Default value thisArg: unknown = this

Returns boolean

each

Parameters

iteratee: Iteratee<number, V | null, this>

Default value thisArg: unknown = this

Default value reverse: boolean = false

Returns this

element

Returns V | null

find

Parameters

predicate: Iteratee<number, V | null, this>

Default value thisArg: unknown = this

Default value reverse: boolean = false

Returns unknown

get

Parameters

index: number

Returns V | null

getCapacity

Returns number

indexOf

Parameters

element: unknown

Default value comparator: Comparator = defaultComparator

Default value thisArg: unknown = this

Returns number

initialize

Returns this

isEmpty

Returns boolean

isInitialized

Returns boolean

isLocked

Returns boolean

isNonNull

Returns boolean

isReadOnly

Protected mem