Skip to content

ConduitOptions

1
type ConduitOptions: BaseConnectionOptions<Conduit> & object;

The options for building a Conduit connection.

Type declaration

MemberTypeDescription
appTokenTokenAdapter<"app">The token adapter for the application token.
conduitCleanupbooleanWhether to cleanup the conduit when it is closed deleting replacing all the shards.
conduitIdstringThe id of the conduit. If not present, a conduit will be created.
deleteConduitOnNoShardsbooleanWhether to delete the conduit when you are going to delete the last shard.
dropSubsAtStartbooleanWhether to drop the subscriptions at the start.
shardsstring[]The shard paths that will be used for establishing the shards at the start.

Source

twitchfy/packages/eventsub/src/types/ConduitOptions.ts:8