Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SQueue<V>

A synchronized queue.

Type parameters

  • V

    a value type

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Events

change

value

  • 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

add

  • add(element: V | null): boolean

  • Adds the specified element to this queue.

    throws

    Error if this is read-only

    throws

    Error if the specified element is null and this does not support a null element

    Parameters

    • element: V | null

      the element to be added

    Returns boolean

    true

addAll

  • addAll(elements: ArrayLike<V | null>): boolean

  • Adds all the elements of the specified array to this queue.

    throws

    Error if this is read-only

    throws

    Error if the specified array is null

    throws

    Error if the specified array contains null and this does not support a null value

    Parameters

    • elements: ArrayLike<V | null>

      the array of elements to be inserted

    Returns boolean

    true if this queue is changed as a result of the call

clear

  • clear(): this

clearAndAdd

  • clearAndAdd(element: V | null): boolean

  • Clear this queue and then appends the specified element at the end of this queue.

    throws

    Error if this is read-only

    throws

    Error if the specified element is null and this does not support a null

    Parameters

    • element: V | null

      element to be pushed

    Returns boolean

    true

clearAndAddAll

  • clearAndAddAll(elements: ArrayLike<V | null>): boolean

  • Clear this queue and then appends all of the elements in the specified array to the end of this queue.

    throws

    Error if this is read-only

    throws

    Error if the specified array is null

    throws

    Error if the specified array contains null and this does not support a null

    Parameters

    • elements: ArrayLike<V | null>

      the array of elements to be appended

    Returns boolean

    true if this list is changed as a result of the call

clearAndOffer

  • clearAndOffer(element: V | null): boolean

  • Clear this queue and then appends the specified element to this queue without raising an exception.

    throws

    Error if this queue does not permit null, and the specified element is null

    Parameters

    • element: V | null

      element to be appended to this queue

    Returns boolean

    true if the specified element is successfully appended

clearAndOfferAll

  • clearAndOfferAll(elements: ArrayLike<V | null>): boolean

  • Clear this queue and then appends the specified elements to this queue.

    throws

    Error if the specified collection is null, or if this queue does not permit null, and the specified collection contains null elements

    Parameters

    • elements: ArrayLike<V | null>

      elements to be appended to this queue

    Returns boolean

    true if this queue is changed as a result of the call

connector

contains

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

containsAll

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

each

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

  • 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

find

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

  • 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

fromJson

  • fromJson(json: unknown): this

get

  • get(index: number): V | null

getCapacity

  • getCapacity(): number

indexOf

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

initialize

  • initialize(): this

isEmpty

  • isEmpty(): boolean

isInitialized

  • isInitialized(): boolean

isLocked

  • isLocked(): boolean

isNonNull

  • isNonNull(): boolean

isReadOnly

  • isReadOnly(): boolean

lastIndexOf

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

lock

  • lock(): 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

  • 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

offer

  • offer(element: V | null): boolean

  • Adds the specified element to this queue.

    throws

    Error if this is read-only

    throws

    Error if the specified element is null and this does not support a null element

    Parameters

    • element: V | null

      the element to be added

    Returns boolean

    true

offoff

offon

on

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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

poll

  • poll(): V | null

remove

  • remove(): V | null

retrigger

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

  • 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

  • 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

setCapacity

  • setCapacity(capacity: number): number

  • Sets to the specified capacity. Older elements are removed to fit to the specified capacity if the number of elements this queue has is larger than the specified capacity.

    throws

    Error if this is read-only

    throws

    Error if the specified capacity is null or negative

    Parameters

    • capacity: number

      the new capacity

    Returns number

    the previous capacity

size

  • size(): number

toArray

  • toArray(): Array<V | null>

toJson

  • toJson(): Array<V | null>

toString

  • toString(): string

trigger

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

  • 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

  • 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[]

uninitialize

  • uninitialize(): this

unlock

  • unlock(): this

Static extend

Generated using TypeDoc