Class NetworkTablesTopic<T>

Type Parameters

T extends NetworkTablesTypes

Hierarchy

NetworkTablesBaseTopic<T>
- NetworkTablesTopic

Index

Constructors

constructor

new NetworkTablesTopic<
    T extends
        | string
        | number
        | boolean
        | string[]
        | ArrayBuffer
        | boolean[]
        | number[],
>(
    client: PubSubClient,
    name: string,
    typeInfo: NetworkTablesTypeInfo,
    defaultValue?: T,
): NetworkTablesTopic<T>
Creates a new topic. This should only be done after the base NTCore client has been initialized.
Type Parameters
- T extends string | number | boolean | string[] | ArrayBuffer | boolean[] | number[]
Parameters
- client: PubSubClient
  The client that owns the topic.
- 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>
Overrides NetworkTablesBaseTopic<T>.constructor
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:56

Properties

`Protected`_announceParams

_announceParams:
    | null
    | {
        id: number;
        name: string;
        properties: { cached?: boolean; persistent?: boolean; retained?: boolean };
        pubuid?: number;
        type:
            | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
    }

`Protected` `Optional`_lastChangedTime

_lastChangedTime?: number

`Protected`client

client: PubSubClient

`Readonly`type

type: "regular" = 'regular'

Accessors

announced

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

Returns boolean
Whether the topic has been announced.
Inherited from NetworkTablesBaseTopic.announced
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:65

id

get id(): undefined | number
Gets the ID of the topic.

Returns undefined | number
The ID of the topic.
Inherited from NetworkTablesBaseTopic.id
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:41

lastChangedTime

get lastChangedTime(): undefined | number
Gets the server time of the last value change.

Returns undefined | number
The server time of the last value change.
Inherited from NetworkTablesBaseTopic.lastChangedTime
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:57

name

get name(): string
Gets the name of the topic.

Returns string
The name of the topic.
Inherited from NetworkTablesBaseTopic.name
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:49

publisher

get publisher(): boolean
Gets whether the client is the publisher of the topic.

Returns boolean
Whether the client is the publisher of the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:36

pubuid

get pubuid(): undefined | number
Gets the UID of the publisher.

Returns undefined | number
The UID of the publisher, or undefined if the client is not the publisher.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:44

subscribers

get subscribers(): Map<
    number,
    {
        callback: CallbackFn<T>;
        options: {
            all?: boolean;
            periodic?: number;
            prefix?: boolean;
            topicsonly?: boolean;
        };
    },
>
Gets the subscribers to the topic.

Returns Map<
    number,
    {
        callback: CallbackFn<T>;
        options: {
            all?: boolean;
            periodic?: number;
            prefix?: boolean;
            topicsonly?: boolean;
        };
    },
>
The subscribers to the topic.
Inherited from NetworkTablesBaseTopic.subscribers
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:73

typeInfo

get typeInfo(): NetworkTablesTypeInfo
Gets the type info for the topic.

Returns NetworkTablesTypeInfo
The type info for the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:28

Methods

announce

announce(
    params: {
        id: number;
        name: string;
        properties: { cached?: boolean; persistent?: boolean; retained?: boolean };
        pubuid?: number;
        type:
            | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
    },
): void
Marks the topic as announced. This should only be called by the PubSubClient.
Parameters
- params: {
      id: number;
      name: string;
      properties: { cached?: boolean; persistent?: boolean; retained?: boolean };
      pubuid?: number;
      type:
          | "string"
          | "boolean"
          | "float"
          | "double"
          | "int"
          | "json"
          | "raw"
          | "rpc"
          | "msgpack"
          | "protobuf"
          | "boolean[]"
          | "double[]"
          | "int[]"
          | "float[]"
          | "string[]";
  }
  The parameters of the announcement.
Returns void
Overrides NetworkTablesBaseTopic.announce
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:116

getValue

getValue(): null | T
Gets the value of the topic.

Returns null | T
The value of the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:92

isPrefix

isPrefix(): this is NetworkTablesPrefixTopic
Returns this is NetworkTablesPrefixTopic
Inherited from NetworkTablesBaseTopic.isPrefix
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:33

isRegular

isRegular(): this is NetworkTablesTopic<
    | string
    | number
    | boolean
    | string[]
    | ArrayBuffer
    | boolean[]
    | number[],
>
Returns this is NetworkTablesTopic<
    | string
    | number
    | boolean
    | string[]
    | ArrayBuffer
    | boolean[]
    | number[],
>
Inherited from NetworkTablesBaseTopic.isRegular
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:29

publish

publish(
    properties?: {
        cached?: boolean;
        persistent?: boolean;
        retained?: boolean;
    },
    id?: number,
): Promise<
    | void
    | {
        method: "announce";
        params: {
            id: number;
            name: string;
            properties: {
                cached?: boolean;
                persistent?: boolean;
                retained?: boolean;
            };
            pubuid?: number;
            type: | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
        };
    },
>
Publishes the topic.
Parameters
- properties: { cached?: boolean; persistent?: boolean; retained?: boolean } = {}
  The properties to publish the topic with.
- Optionalid: number
  The UID of the publisher. You must verify that the ID is not already in use.
Returns Promise<
    | void
    | {
        method: "announce";
        params: {
            id: number;
            name: string;
            properties: {
                cached?: boolean;
                persistent?: boolean;
                retained?: boolean;
            };
            pubuid?: number;
            type: | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
        };
    },
>
A promise that resolves when the topic is published.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:176

republish

republish(
    client: PubSubClient,
): Promise<
    | void
    | {
        method: "announce";
        params: {
            id: number;
            name: string;
            properties: {
                cached?: boolean;
                persistent?: boolean;
                retained?: boolean;
            };
            pubuid?: number;
            type: | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
        };
    },
>
Republishes the topic.
Parameters
- client: PubSubClient
  The client to republish with.
Returns Promise<
    | void
    | {
        method: "announce";
        params: {
            id: number;
            name: string;
            properties: {
                cached?: boolean;
                persistent?: boolean;
                retained?: boolean;
            };
            pubuid?: number;
            type: | "string"
            | "boolean"
            | "float"
            | "double"
            | "int"
            | "json"
            | "raw"
            | "rpc"
            | "msgpack"
            | "protobuf"
            | "boolean[]"
            | "double[]"
            | "int[]"
            | "float[]"
            | "string[]";
        };
    },
>
A promise that resolves when the topic is republished.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:211

resubscribeAll

resubscribeAll(client: PubSubClient): void
Resubscribes all local subscribers.
Parameters
- client: PubSubClient
  The client to resubscribe with.
Returns void
Overrides NetworkTablesBaseTopic.resubscribeAll
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:150

setProperties

setProperties(
persistent?: boolean,
retained?: boolean,
): Promise<{ method: "properties"; params: { ack: boolean; name: string } }>
Sets the properties of the topic.
Parameters
- Optionalpersistent: boolean
  If true, the last set value will be periodically saved to persistent storage on the server and be restored during server startup. Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.
- Optionalretained: boolean
  Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.
Returns Promise<{ method: "properties"; params: { ack: boolean; name: string } }>
The server's response.
Inherited from NetworkTablesBaseTopic.setProperties
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:156

setValue

setValue(value: T): void
Sets the value of the topic. The client must be the publisher of the topic to set the value.
Parameters
- value: T
  The value to set.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:79

subscribe(
    callback: CallbackFn<T>,
    options?: Omit<
        {
            all?: boolean;
            periodic?: number;
            prefix?: boolean;
            topicsonly?: boolean;
        },
        "prefix",
    >,
    id?: number,
    save?: boolean,
): number
Creates a new subscriber.
Parameters
- callback: CallbackFn<T>
  The callback to call when the topic value changes.
- options: Omit<
      {
          all?: boolean;
          periodic?: number;
          prefix?: boolean;
          topicsonly?: boolean;
      },
      "prefix",
  > = {}
  The options for the subscriber.
- Optionalid: number
  The UID of the subscriber. You must verify that the ID is not already in use.
- save: boolean = true
  Whether to save the subscriber.
Returns number
The UID of the subscriber.
Overrides NetworkTablesBaseTopic.subscribe
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:135

unannounce

unannounce(): void
Marks the topic as unannounced. This should only be called by the PubSubClient.

Returns void
Inherited from NetworkTablesBaseTopic.unannounce
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:104

unpublish

unpublish(): void
Unpublishes the topic.

Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:195

unsubscribe

unsubscribe(subuid: number, removeCallback?: boolean): void
Removes a subscriber
Parameters
- subuid: number
  The UID of the subscriber.
- removeCallback: boolean = true
  Whether to remove the callback. Leave this as true unless you know what you're doing.
Returns void
Inherited from NetworkTablesBaseTopic.unsubscribe
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:134

unsubscribeAll

unsubscribeAll(): void
Removes all local subscribers.

Returns void
Inherited from NetworkTablesBaseTopic.unsubscribeAll
- Defined in packages/ntcore-ts-client/src/lib/pubsub/base-topic.ts:142

updateValue

updateValue(value: T, lastChangedTime: number): void
Updates the value of the topic. This should only be called by the PubSubClient.
Parameters
- value: T
  The value to update.
- lastChangedTime: number
  The server time of the last value change.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:102

Class NetworkTablesTopic<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NetworkTablesTopic<T>

Properties

Protected_announceParams

Protected Optional_lastChangedTime

Protectedclient

Readonlytype

Accessors

announced

Returns boolean

id

Returns undefined | number

lastChangedTime

Returns undefined | number

name

Returns string

publisher

Returns boolean

pubuid

Returns undefined | number

subscribers

Returns Map< number, { callback: CallbackFn<T>; options: { all?: boolean; periodic?: number; prefix?: boolean; topicsonly?: boolean; }; },>

typeInfo

Returns NetworkTablesTypeInfo

Methods

announce

Parameters

Returns void

getValue

Returns null | T

isPrefix

Returns this is NetworkTablesPrefixTopic

isRegular

Returns this is NetworkTablesTopic< | string | number | boolean | string[] | ArrayBuffer | boolean[] | number[],>

publish

Parameters

republish

Parameters

resubscribeAll

Parameters

Returns void

setProperties

Parameters

Returns Promise<{ method: "properties"; params: { ack: boolean; name: string } }>

setValue

Parameters

Returns void

subscribe

Parameters

Returns number

unannounce

Returns void

unpublish

Returns void

unsubscribe

Parameters

Returns void

unsubscribeAll

Returns void

updateValue

Parameters

Returns void

Settings

On This Page

`Protected`_announceParams

`Protected` `Optional`_lastChangedTime

`Protected`client

`Readonly`type

Returns Map<
number,
{
callback: CallbackFn<T>;
options: {
all?: boolean;
periodic?: number;
prefix?: boolean;
topicsonly?: boolean;
};
},
>

Returns this is NetworkTablesTopic<
| string
| number
| boolean
| string[]
| ArrayBuffer
| boolean[]
| number[],
>