Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArtSerializer

ArtSerializer serializes and deseriales Collboard arts and other objects

  • Serializer is generic serializer which can work with any rules; it works synchronously
  • Serializer with basic rules is Serializer which has registered basic rules; it works synchronously
  • ArtSerializer serializes and deseriales Collboard arts and other objects; it works asynchronously
collboard-system

Hierarchy

  • AbstractSystem
    • ArtSerializer

Implements

  • ISerializer<ICollboardSerializable>

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns ArtSerializer

Properties

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Private Readonly serializer

serializer: any
@x

Using composition over inheritance patern

Protected Readonly systems

systems: ISystemsExtended

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): ArtSerializer

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ArtSerializer

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

deserialize

  • deserialize(serialized: JsonValue): Promise<ICollboardSerializable>
  • @x

    copy from serializer

    Parameters

    • serialized: JsonValue

    Returns Promise<ICollboardSerializable>

deserializeWithRecursionProtection

  • deserializeWithRecursionProtection(serialized: JsonValue, errors: DeserializationError[]): Promise<ICollboardSerializable>
  • @x

    copy from serializer

    Parameters

    • serialized: JsonValue
    • errors: DeserializationError[]

    Returns Promise<ICollboardSerializable>

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

registerRule

  • registerRule(...rules: ISerializerRule[]): Registration
  • @x

    copy from serializer

    Parameters

    • Rest ...rules: ISerializerRule[]

    Returns Registration

serialize

  • serialize(value: ICollboardSerializable): Promise<JsonValue>
  • @x

    copy from serializer

    Parameters

    • value: ICollboardSerializable

    Returns Promise<JsonValue>

serializeWithRecursionProtection

  • serializeWithRecursionProtection(value: ICollboardSerializable, errors: SerializationError[]): Promise<JsonValue>
  • @x

    copy from serializer

    Parameters

    • value: ICollboardSerializable
    • errors: SerializationError[]

    Returns Promise<JsonValue>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable