Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SString

A synchronized string.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected __mem__

__mem__: SStringMemory

Methods

compareAndSet

  • compareAndSet(expected: string | null, update: string | null, forcibly?: boolean): boolean

  • Sets to the update if the expected equals to this value and the update differs from the current value. If the forcibly is true, sets to the specified value even if the update equals to the current value.

    throws

    Error if this is read-only

    throws

    Error if update is null and this is non-null

    Parameters

    • expected: string | null

      the expected value

    • update: string | null

      the new value

    • Default value forcibly: boolean = false

      true to ignore an equality check

    Returns boolean

    true if the expected is equal to this value

compareTo

  • compareTo(value: string | null | SScalar<string>): number

  • Compares this value with the specified value. Returns a negative integer, zero, a positive integer as this value is less than, equals to, or greater than the specified value.

    Parameters

    • value: string | null | SScalar<string>

      value to be compared

    Returns number

    a negative integer, zero, a positive integer as this value is less than, equals to, or greater than the specified value

compareToIgnoreCase

  • compareToIgnoreCase(string: string | null): number
  • compareToIgnoreCase(sscalar: SScalar<string>): number

concat

  • concat(string: string | null): string | null

  • Concatenates the specified string to the end of this string and returns a concatenated string. Returns null if this string is null.

    Parameters

    • string: string | null

      string to be concatenated

    Returns string | null

    concatenated string

connector

contains

  • contains(sequence: string): boolean

containsAll

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

each

  • each(iteratee: Iteratee<string, any, this>, thisArg?: SScalarMemory<string>, reverse?: undefined | false | true): this
  • each(iteratee: Iteratee<number, any, this>, thisArg?: SScalarMemory<string>, reverse?: undefined | false | true): this

  • If the value is an object/an array, iterates over fields/elements of the value, calling the iteratee for each field/element. The iteratee is invoked with three arguments: field value/element, field name/index and this instance.

    If the value is null/undefined, does not invoke the iteratee.

    For anything else, invokes the iteratee with three arguments: the value, null and this instance.

    The iteratee is bound to the specified thisArg and may exit iteration early by explicitly returning false.

    Parameters

    • iteratee: Iteratee<string, any, this>

      the function called per iteration

    • Optional thisArg: SScalarMemory<string>

      the this binding of the iteratee

    • Optional reverse: undefined | false | true

      true to iterate in the reverse order if the value is an array

    Returns this

    this

  • If the value is an object/an array, iterates over fields/elements of the value, calling the iteratee for each field/element. The iteratee is invoked with three arguments: field value/element, field name/index and this instance.

    If the value is null/undefined, does not invoke the iteratee.

    For anything else, invokes the iteratee with three arguments: the value, null and this instance.

    The iteratee is bound to the specified thisArg and may exit iteration early by explicitly returning false.

    Parameters

    • iteratee: Iteratee<number, any, this>

      the function called per iteration

    • Optional thisArg: SScalarMemory<string>

      the this binding of the iteratee

    • Optional reverse: undefined | false | true

      true to iterate in the reverse order if the value is an array

    Returns this

    this

endsWith

  • endsWith(suffix: string): boolean

equals

  • equals(value: string | null | SScalar<string>): boolean

equalsIgnoreCase

  • equalsIgnoreCase(string: string | null): boolean
  • equalsIgnoreCase(sscalar: SScalar<string>): boolean

find

  • find(predicate: Iteratee<string, any, this>, thisArg?: unknown, reverse?: undefined | false | true): unknown
  • find(predicate: Iteratee<number, any, this>, thisArg?: unknown, reverse?: undefined | false | true): unknown

  • If the value is an object/an array, returns the first field/element which the specified predicate returns true or null if there is no such field/element. The predicate is bound to the thisArg and invoked with three arguments: value, field name/index and this instance.

    If the value is null/undefined, does not invokes the predicate and returns null.

    For anything else, invokes the predicate with three arguments: the value, null and this instance, and returns the value if the predicate returns true.

    Parameters

    • predicate: Iteratee<string, any, this>

      the function called per iteration

    • Optional thisArg: unknown

      the this binding of the predicate

    • Optional reverse: undefined | false | true

      true to iterate in the reverse order if the value is an array

    Returns unknown

    the found value or null

  • If the value is an object/an array, returns the first field/element which the specified predicate returns true or null if there is no such field/element. The predicate is bound to the thisArg and invoked with three arguments: value, field name/index and this instance.

    If the value is null/undefined, does not invokes the predicate and returns null.

    For anything else, invokes the predicate with three arguments: the value, null and this instance, and returns the value if the predicate returns true.

    Parameters

    • predicate: Iteratee<number, any, this>

      the function called per iteration

    • Optional thisArg: unknown

      the this binding of the predicate

    • Optional reverse: undefined | false | true

      true to iterate in the reverse order if the value is an array

    Returns unknown

    the found value or null

fromJson

  • fromJson(json: unknown): this

fromString

  • fromString(str: string): this

get

  • get(): string | null

getAndSet

  • getAndSet(value: string | null, forcibly?: boolean): string | null

  • Sets to the specified value and returns the old value if the specified value differs from the current value. If the forcibly is true, sets to the specified value even if the specified value equals to the current value.

    throws

    Error if this is read-only

    throws

    Error if value is null and this is non-null

    Parameters

    • value: string | null

      the new value

    • Default value forcibly: boolean = false

      true to ignore an equality check

    Returns string | null

    the old value

getValue

  • getValue(): string | null

indexOf

  • indexOf(substring: string, fromIndex?: undefined | number): number
  • indexOf(value: unknown, comparator?: Comparator, thisArg?: unknown): number

initialize

  • initialize(): this

isEmpty

  • isEmpty(): boolean

isInitialized

  • isInitialized(): boolean

isLocked

  • isLocked(): boolean

isNonNull

  • isNonNull(): boolean

isNotNull

  • isNotNull(): boolean

isNull

  • isNull(): boolean

isReadOnly

  • isReadOnly(): boolean

lastIndexOf

  • lastIndexOf(substring: string, fromIndex?: undefined | number): number
  • lastIndexOf(value: unknown, comparator?: Comparator, thisArg?: unknown): number

length

  • length(): number

lock

  • lock(): this

matches

  • matches(regex: string): boolean
  • matches(regex: RegExp): boolean

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

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

reset

  • reset(): string | null

resetValue

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

set

  • set(value: string | null, forcibly?: boolean): this

  • Sets to the specified value if the specified value differs from the current value. If the forcibly is true, sets to the specified value even if the specified value equals to the current value.

    throws

    Error if this is read-only

    throws

    Error if value is null and this is non-null

    Parameters

    • value: string | null

      new value

    • Default value forcibly: boolean = false

      true to ignore an equality check

    Returns this

    this

setValue

  • setValue(value: string | null, forcibly?: boolean): this

  • Sets to the specified value if the specified value differs from the current value. If the forcibly is true, sets to the specified value even if the specified value equals to the current value.

    throws

    Error if this is read-only

    throws

    Error if value is null and this is non-null

    Parameters

    • value: string | null

      the new value

    • Default value forcibly: boolean = false

      true to ignore an equality check

    Returns this

    this

size

  • size(): number

startsWith

  • startsWith(prefix: string, offset?: number): boolean

  • Returns true if the substring of this string beginning at the specified index starts with the specified prefix. Returns false if this string is null.

    Parameters

    • prefix: string

      prefix to search for

    • Default value offset: number = 0

      where to begin looking in this string

    Returns boolean

    true if the substring of this string beginning at the specified index starts with the specified prefix

substring

  • substring(beginIndex: number, endIndex?: number): string

  • Returns a new string that is a substring of this string.

    throws

    Error if beginIndex is negative or larger than the length of this string object

    Parameters

    • beginIndex: number

      beginning index (inclusive)

    • Default value endIndex: number = this.length()

      ending index (exclusive)

    Returns string

    substring of this string

toDirty

  • toDirty(): this

toJson

  • toJson(): unknown

toLowerCase

  • toLowerCase(): string | null

toString

  • toString(): string

toUpperCase

  • toUpperCase(): string | null

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

trim

  • trim(): string | null

uninitialize

  • uninitialize(): this

unlock

  • unlock(): this

Static extend

Generated using TypeDoc