diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 11a8476..79ed0f7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -29,7 +29,7 @@ jobs: - run: npx nx run-many -t test --coverage - name: Upload coverage reports to Codecov - uses: codecov/codecov-action@v3 + uses: codecov/codecov-action@v4 env: CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} flags: unittests diff --git a/docs/classes/NetworkTables.html b/docs/classes/NetworkTables.html index 16f6867..8be92fb 100644 --- a/docs/classes/NetworkTables.html +++ b/docs/classes/NetworkTables.html @@ -1,5 +1,5 @@ NetworkTables | ntcore-ts-client

NetworkTables class for interacting with NetworkTables over a WebSocket connection.

-

Accessors

Accessors

Methods

Methods

  • Adds a listener for robot connection status updates.

    Parameters

    • callback: ((_: boolean) => void)

      The callback to call when the connection status changes.

        • (_): void
        • Parameters

          • _: boolean

          Returns void

    • OptionalimmediateNotify: boolean

      Whether to immediately notify the callback of the current connection status.

    Returns (() => void)

    A function to remove the listener.

    -
      • (): void
      • Returns void

  • Creates a new NetworkTables instance if it does not exist.

    +
+
diff --git a/docs/classes/NetworkTablesTopic.html b/docs/classes/NetworkTablesTopic.html index e303aea..4a2d3cb 100644 --- a/docs/classes/NetworkTablesTopic.html +++ b/docs/classes/NetworkTablesTopic.html @@ -1,4 +1,4 @@ -NetworkTablesTopic | ntcore-ts-client

Class NetworkTablesTopic<T>

Type Parameters

Constructors

constructor +NetworkTablesTopic | ntcore-ts-client

Class NetworkTablesTopic<T>

Type Parameters

Constructors

Accessors

announced id lastChangedTime @@ -26,56 +26,56 @@
  • name: string

    The name of the topic.

  • typeInfo: NetworkTablesTypeInfo

    The type info for the topic.

  • OptionaldefaultValue: T

    The default value for the topic.

    -
  • Returns NetworkTablesTopic<T>

    Accessors

    • get announced(): boolean
    • Whether the topic has been announced.

      +

    Returns NetworkTablesTopic<T>

    Accessors

    • get subscribers(): Map<number, {
          callback: ((_: null | T) => void);
          immediateNotify: boolean;
          options: {
              all?: boolean;
              periodic?: number;
              prefix?: boolean;
              topicsonly?: boolean;
          };
      }>
    • Gets the subscribers to the topic.

      +
    • get subscribers(): Map<number, {
          callback: ((_: null | T) => void);
          immediateNotify: boolean;
          options: {
              all?: boolean;
              periodic?: number;
              prefix?: boolean;
              topicsonly?: boolean;
          };
      }>
    • Gets the subscribers to the topic.

      Returns Map<number, {
          callback: ((_: null | T) => void);
          immediateNotify: boolean;
          options: {
              all?: boolean;
              periodic?: number;
              prefix?: boolean;
              topicsonly?: boolean;
          };
      }>

      The subscribers to the topic.

      -

    Methods

    Methods

    • Marks the topic as announced. This should only be called by the PubSubClient.

      Parameters

      • id: number

        The ID of the topic.

      • Optionalpubuid: number

        The UID of the publisher.

        -

      Returns void

    • Publishes the topic.

      +

    Returns void

    Returns void

    Returns void

    Returns void

    +

    Returns void

    diff --git a/docs/classes/NetworkTablesTypeInfos.html b/docs/classes/NetworkTablesTypeInfos.html index e6db20c..4de2ffa 100644 --- a/docs/classes/NetworkTablesTypeInfos.html +++ b/docs/classes/NetworkTablesTypeInfos.html @@ -1,4 +1,4 @@ -NetworkTablesTypeInfos | ntcore-ts-client

    Class NetworkTablesTypeInfos

    Constructors

    constructor +NetworkTablesTypeInfos | ntcore-ts-client

    Class NetworkTablesTypeInfos

    Constructors

    Properties

    kArrayBuffer: NetworkTablesTypeInfo = ...
    kBoolean: NetworkTablesTypeInfo = ...
    kBooleanArray: NetworkTablesTypeInfo = ...
    kDouble: NetworkTablesTypeInfo = ...
    kDoubleArray: NetworkTablesTypeInfo = ...
    kInteger: NetworkTablesTypeInfo = ...
    kIntegerArray: NetworkTablesTypeInfo = ...
    kString: NetworkTablesTypeInfo = ...
    kStringArray: NetworkTablesTypeInfo = ...
    +

    Constructors

    Properties

    kArrayBuffer: NetworkTablesTypeInfo = ...
    kBoolean: NetworkTablesTypeInfo = ...
    kBooleanArray: NetworkTablesTypeInfo = ...
    kDouble: NetworkTablesTypeInfo = ...
    kDoubleArray: NetworkTablesTypeInfo = ...
    kInteger: NetworkTablesTypeInfo = ...
    kIntegerArray: NetworkTablesTypeInfo = ...
    kString: NetworkTablesTypeInfo = ...
    kStringArray: NetworkTablesTypeInfo = ...
    diff --git a/docs/interfaces/BinaryMessageData.html b/docs/interfaces/BinaryMessageData.html index 248a0ed..14931b1 100644 --- a/docs/interfaces/BinaryMessageData.html +++ b/docs/interfaces/BinaryMessageData.html @@ -1,5 +1,5 @@ -BinaryMessageData | ntcore-ts-client

    Interface BinaryMessageData

    interface BinaryMessageData {
        serverTime: number;
        topicId: number;
        typeInfo: NetworkTablesTypeInfos;
        value:
            | string
            | number
            | boolean
            | string[]
            | ArrayBuffer
            | boolean[]
            | number[];
    }

    Properties

    serverTime +BinaryMessageData | ntcore-ts-client

    Interface BinaryMessageData

    interface BinaryMessageData {
        serverTime: number;
        topicId: number;
        typeInfo: NetworkTablesTypeInfos;
        value:
            | string
            | number
            | boolean
            | string[]
            | ArrayBuffer
            | boolean[]
            | number[];
    }

    Properties

    serverTime: number
    topicId: number
    value:
        | string
        | number
        | boolean
        | string[]
        | ArrayBuffer
        | boolean[]
        | number[]
    +

    Properties

    serverTime: number
    topicId: number
    value:
        | string
        | number
        | boolean
        | string[]
        | ArrayBuffer
        | boolean[]
        | number[]
    diff --git a/docs/types/AnnounceMessage.html b/docs/types/AnnounceMessage.html index abe6a7b..21d8eee 100644 --- a/docs/types/AnnounceMessage.html +++ b/docs/types/AnnounceMessage.html @@ -1 +1 @@ -AnnounceMessage | ntcore-ts-client

    Type Alias AnnounceMessage

    AnnounceMessage: z.infer<typeof announceMessageSchema>
    +AnnounceMessage | ntcore-ts-client

    Type Alias AnnounceMessage

    AnnounceMessage: z.infer<typeof announceMessageSchema>
    diff --git a/docs/types/AnnounceMessageParams.html b/docs/types/AnnounceMessageParams.html index 287567a..8751549 100644 --- a/docs/types/AnnounceMessageParams.html +++ b/docs/types/AnnounceMessageParams.html @@ -1 +1 @@ -AnnounceMessageParams | ntcore-ts-client

    Type Alias AnnounceMessageParams

    AnnounceMessageParams: AnnounceMessage["params"]
    +AnnounceMessageParams | ntcore-ts-client

    Type Alias AnnounceMessageParams

    AnnounceMessageParams: AnnounceMessage["params"]
    diff --git a/docs/types/BinaryMessage.html b/docs/types/BinaryMessage.html index 44eecf0..a1dd521 100644 --- a/docs/types/BinaryMessage.html +++ b/docs/types/BinaryMessage.html @@ -1 +1 @@ -BinaryMessage | ntcore-ts-client

    Type Alias BinaryMessage

    BinaryMessage: z.infer<typeof msgPackSchema>
    +BinaryMessage | ntcore-ts-client

    Type Alias BinaryMessage

    BinaryMessage: z.infer<typeof msgPackSchema>
    diff --git a/docs/types/Message.html b/docs/types/Message.html index 7342605..f680f78 100644 --- a/docs/types/Message.html +++ b/docs/types/Message.html @@ -1 +1 @@ -Message | ntcore-ts-client

    Type Alias Message

    Message:
        | PublishMessage
        | UnpublishMessage
        | SetPropertiesMessage
        | SubscribeMessage
        | UnsubscribeMessage
        | AnnounceMessage
        | UnannounceMessage
        | PropertiesMessage
    +Message | ntcore-ts-client

    Type Alias Message

    Message:
        | PublishMessage
        | UnpublishMessage
        | SetPropertiesMessage
        | SubscribeMessage
        | UnsubscribeMessage
        | AnnounceMessage
        | UnannounceMessage
        | PropertiesMessage
    diff --git a/docs/types/NetworkTablesTypeInfo.html b/docs/types/NetworkTablesTypeInfo.html index 8bf535d..26aa233 100644 --- a/docs/types/NetworkTablesTypeInfo.html +++ b/docs/types/NetworkTablesTypeInfo.html @@ -1 +1 @@ -NetworkTablesTypeInfo | ntcore-ts-client

    Type Alias NetworkTablesTypeInfo

    NetworkTablesTypeInfo: [TypeNum, TypeString]
    +NetworkTablesTypeInfo | ntcore-ts-client

    Type Alias NetworkTablesTypeInfo

    NetworkTablesTypeInfo: [TypeNum, TypeString]
    diff --git a/docs/types/NetworkTablesTypes.html b/docs/types/NetworkTablesTypes.html index 4f3070a..ba5528e 100644 --- a/docs/types/NetworkTablesTypes.html +++ b/docs/types/NetworkTablesTypes.html @@ -1 +1 @@ -NetworkTablesTypes | ntcore-ts-client

    Type Alias NetworkTablesTypes

    NetworkTablesTypes: z.infer<typeof msgPackValueSchema>
    +NetworkTablesTypes | ntcore-ts-client

    Type Alias NetworkTablesTypes

    NetworkTablesTypes: z.infer<typeof msgPackValueSchema>
    diff --git a/docs/types/PropertiesMessage.html b/docs/types/PropertiesMessage.html index 7ce77f7..0ea191a 100644 --- a/docs/types/PropertiesMessage.html +++ b/docs/types/PropertiesMessage.html @@ -1 +1 @@ -PropertiesMessage | ntcore-ts-client

    Type Alias PropertiesMessage

    PropertiesMessage: z.infer<typeof propertiesMessageSchema>
    +PropertiesMessage | ntcore-ts-client

    Type Alias PropertiesMessage

    PropertiesMessage: z.infer<typeof propertiesMessageSchema>
    diff --git a/docs/types/PropertiesMessageParams.html b/docs/types/PropertiesMessageParams.html index bb79c9f..4c1b01b 100644 --- a/docs/types/PropertiesMessageParams.html +++ b/docs/types/PropertiesMessageParams.html @@ -1 +1 @@ -PropertiesMessageParams | ntcore-ts-client

    Type Alias PropertiesMessageParams

    PropertiesMessageParams: PropertiesMessage["params"]
    +PropertiesMessageParams | ntcore-ts-client

    Type Alias PropertiesMessageParams

    PropertiesMessageParams: PropertiesMessage["params"]
    diff --git a/docs/types/PublishMessage.html b/docs/types/PublishMessage.html index c5bc6ef..d222376 100644 --- a/docs/types/PublishMessage.html +++ b/docs/types/PublishMessage.html @@ -1 +1 @@ -PublishMessage | ntcore-ts-client

    Type Alias PublishMessage

    PublishMessage: z.infer<typeof publishMessageSchema>
    +PublishMessage | ntcore-ts-client

    Type Alias PublishMessage

    PublishMessage: z.infer<typeof publishMessageSchema>
    diff --git a/docs/types/PublishMessageParams.html b/docs/types/PublishMessageParams.html index 738881e..1e5e387 100644 --- a/docs/types/PublishMessageParams.html +++ b/docs/types/PublishMessageParams.html @@ -1 +1 @@ -PublishMessageParams | ntcore-ts-client

    Type Alias PublishMessageParams

    PublishMessageParams: PublishMessage["params"]
    +PublishMessageParams | ntcore-ts-client

    Type Alias PublishMessageParams

    PublishMessageParams: PublishMessage["params"]
    diff --git a/docs/types/SetPropertiesMessage.html b/docs/types/SetPropertiesMessage.html index 2b34888..30ba922 100644 --- a/docs/types/SetPropertiesMessage.html +++ b/docs/types/SetPropertiesMessage.html @@ -1 +1 @@ -SetPropertiesMessage | ntcore-ts-client

    Type Alias SetPropertiesMessage

    SetPropertiesMessage: z.infer<typeof setPropertiesMessageSchema>
    +SetPropertiesMessage | ntcore-ts-client

    Type Alias SetPropertiesMessage

    SetPropertiesMessage: z.infer<typeof setPropertiesMessageSchema>
    diff --git a/docs/types/SetPropertiesMessageParams.html b/docs/types/SetPropertiesMessageParams.html index 5cb5bcd..5dfc2ea 100644 --- a/docs/types/SetPropertiesMessageParams.html +++ b/docs/types/SetPropertiesMessageParams.html @@ -1 +1 @@ -SetPropertiesMessageParams | ntcore-ts-client

    Type Alias SetPropertiesMessageParams

    SetPropertiesMessageParams: SetPropertiesMessage["params"]
    +SetPropertiesMessageParams | ntcore-ts-client

    Type Alias SetPropertiesMessageParams

    SetPropertiesMessageParams: SetPropertiesMessage["params"]
    diff --git a/docs/types/SubscribeMessage.html b/docs/types/SubscribeMessage.html index 89cb3c3..53d805d 100644 --- a/docs/types/SubscribeMessage.html +++ b/docs/types/SubscribeMessage.html @@ -1 +1 @@ -SubscribeMessage | ntcore-ts-client

    Type Alias SubscribeMessage

    SubscribeMessage: z.infer<typeof subscribeMessageSchema>
    +SubscribeMessage | ntcore-ts-client

    Type Alias SubscribeMessage

    SubscribeMessage: z.infer<typeof subscribeMessageSchema>
    diff --git a/docs/types/SubscribeMessageParams.html b/docs/types/SubscribeMessageParams.html index 8e580b8..a3d0fa0 100644 --- a/docs/types/SubscribeMessageParams.html +++ b/docs/types/SubscribeMessageParams.html @@ -1 +1 @@ -SubscribeMessageParams | ntcore-ts-client

    Type Alias SubscribeMessageParams

    SubscribeMessageParams: SubscribeMessage["params"]
    +SubscribeMessageParams | ntcore-ts-client

    Type Alias SubscribeMessageParams

    SubscribeMessageParams: SubscribeMessage["params"]
    diff --git a/docs/types/SubscribeOptions.html b/docs/types/SubscribeOptions.html index fdb48be..e8ac2dc 100644 --- a/docs/types/SubscribeOptions.html +++ b/docs/types/SubscribeOptions.html @@ -1 +1 @@ -SubscribeOptions | ntcore-ts-client

    Type Alias SubscribeOptions

    SubscribeOptions: z.infer<typeof subscriptionOptionsSchema>
    +SubscribeOptions | ntcore-ts-client

    Type Alias SubscribeOptions

    SubscribeOptions: z.infer<typeof subscriptionOptionsSchema>
    diff --git a/docs/types/TopicProperties.html b/docs/types/TopicProperties.html index 7378cb3..0c0ef38 100644 --- a/docs/types/TopicProperties.html +++ b/docs/types/TopicProperties.html @@ -1 +1 @@ -TopicProperties | ntcore-ts-client

    Type Alias TopicProperties

    TopicProperties: z.infer<typeof topicPropertiesSchema>
    +TopicProperties | ntcore-ts-client

    Type Alias TopicProperties

    TopicProperties: z.infer<typeof topicPropertiesSchema>
    diff --git a/docs/types/TypeNum.html b/docs/types/TypeNum.html index af672c9..ab157d8 100644 --- a/docs/types/TypeNum.html +++ b/docs/types/TypeNum.html @@ -1 +1 @@ -TypeNum | ntcore-ts-client

    Type Alias TypeNum

    TypeNum: z.infer<typeof typeNumSchema>
    +TypeNum | ntcore-ts-client

    Type Alias TypeNum

    TypeNum: z.infer<typeof typeNumSchema>
    diff --git a/docs/types/TypeString.html b/docs/types/TypeString.html index d3aa50c..a9d243e 100644 --- a/docs/types/TypeString.html +++ b/docs/types/TypeString.html @@ -1 +1 @@ -TypeString | ntcore-ts-client

    Type Alias TypeString

    TypeString: z.infer<typeof typeStringSchema>
    +TypeString | ntcore-ts-client

    Type Alias TypeString

    TypeString: z.infer<typeof typeStringSchema>
    diff --git a/docs/types/UnannounceMessage.html b/docs/types/UnannounceMessage.html index e616925..46db603 100644 --- a/docs/types/UnannounceMessage.html +++ b/docs/types/UnannounceMessage.html @@ -1 +1 @@ -UnannounceMessage | ntcore-ts-client

    Type Alias UnannounceMessage

    UnannounceMessage: z.infer<typeof unannounceMessageSchema>
    +UnannounceMessage | ntcore-ts-client

    Type Alias UnannounceMessage

    UnannounceMessage: z.infer<typeof unannounceMessageSchema>
    diff --git a/docs/types/UnannounceMessageParams.html b/docs/types/UnannounceMessageParams.html index 9d2653f..24f9a8b 100644 --- a/docs/types/UnannounceMessageParams.html +++ b/docs/types/UnannounceMessageParams.html @@ -1 +1 @@ -UnannounceMessageParams | ntcore-ts-client

    Type Alias UnannounceMessageParams

    UnannounceMessageParams: UnannounceMessage["params"]
    +UnannounceMessageParams | ntcore-ts-client

    Type Alias UnannounceMessageParams

    UnannounceMessageParams: UnannounceMessage["params"]
    diff --git a/docs/types/UnpublishMessage.html b/docs/types/UnpublishMessage.html index e39a68b..be8f0f9 100644 --- a/docs/types/UnpublishMessage.html +++ b/docs/types/UnpublishMessage.html @@ -1 +1 @@ -UnpublishMessage | ntcore-ts-client

    Type Alias UnpublishMessage

    UnpublishMessage: z.infer<typeof unpublishMessageSchema>
    +UnpublishMessage | ntcore-ts-client

    Type Alias UnpublishMessage

    UnpublishMessage: z.infer<typeof unpublishMessageSchema>
    diff --git a/docs/types/UnpublishMessageParams.html b/docs/types/UnpublishMessageParams.html index e901b12..074e6f6 100644 --- a/docs/types/UnpublishMessageParams.html +++ b/docs/types/UnpublishMessageParams.html @@ -1 +1 @@ -UnpublishMessageParams | ntcore-ts-client

    Type Alias UnpublishMessageParams

    UnpublishMessageParams: UnpublishMessage["params"]
    +UnpublishMessageParams | ntcore-ts-client

    Type Alias UnpublishMessageParams

    UnpublishMessageParams: UnpublishMessage["params"]
    diff --git a/docs/types/UnsubscribeMessage.html b/docs/types/UnsubscribeMessage.html index 627faba..e182f89 100644 --- a/docs/types/UnsubscribeMessage.html +++ b/docs/types/UnsubscribeMessage.html @@ -1 +1 @@ -UnsubscribeMessage | ntcore-ts-client

    Type Alias UnsubscribeMessage

    UnsubscribeMessage: z.infer<typeof unsubscribeMessageSchema>
    +UnsubscribeMessage | ntcore-ts-client

    Type Alias UnsubscribeMessage

    UnsubscribeMessage: z.infer<typeof unsubscribeMessageSchema>
    diff --git a/docs/types/UnsubscribeMessageParams.html b/docs/types/UnsubscribeMessageParams.html index 4738fe7..b8cd70a 100644 --- a/docs/types/UnsubscribeMessageParams.html +++ b/docs/types/UnsubscribeMessageParams.html @@ -1 +1 @@ -UnsubscribeMessageParams | ntcore-ts-client

    Type Alias UnsubscribeMessageParams

    UnsubscribeMessageParams: UnsubscribeMessage["params"]
    +UnsubscribeMessageParams | ntcore-ts-client

    Type Alias UnsubscribeMessageParams

    UnsubscribeMessageParams: UnsubscribeMessage["params"]