Type Aliases
Type Aliases
63 public type aliases exported by hoshimi.
Type63type aliaseshoshimi0.5.5
Type Aliases
63
AnyLavalinkTrackTypeThe type for any lavalink track, including partial and unresolved tracks.AwaitableTypeMake a function awaitable by returning a promise or the value.CapabilityKeyTypeThe custom capability keys provided by users via module augmentation.CustomSearchSourcesTypeThe custom search source keys provided by users.CustomSourceNamesTypeThe custom source names provided by users.DeepRequiredTypeMake a type required.EventKeyTypeThe event names a map declares.EventListenerTypeThe listener of a single event, taking the parameters from the map's tuple.EventMapTypeThe shape an event map has to satisfy.FilterManagerStructureTypeThe structure for the FilterManager class.FilterNameKeyTypeThe custom filter name keys provided by users via module augmentation.FilterRouteTypeThe envelope coordinates of a filter: everything needed to place its payload on the wire. A {@link FilterRegistration} satisfies it, and so does a synthetic route built on the fly for a filter that was never registered (see `FilterManager.set`).HintTypeA hint type that can be either the type or a string.IfTypeConditional type to check if T is true, then A, else B or A | null.InferableTypeCreate a type that infers the value of a key from an object.InferCustomStructureTypeInfers the custom structure for a given class.LavalinkEventPayloadTypeThe type of the payload for the socket.LavalinkPlayerVoiceTypeThe voice settings for the player.LavalinkSearchResponseTypeThe response of the result.LyricsManagerStructureTypeThe structure for the LyricsManager class.NodeDisconnectInfoTypeThe type of the node disconnect object.NodeIdentifierTypeA node identifier can be either a string or a node structure.NodeManagerStructureTypeThe structure for the NodeManager class.NodeSortFilterTypeThe type for the player move filter.NodeSortFunctionTypeThe type for the node sort function.NodeStructureTypeThe structure for the Node class.NullableTypeMake a type nullable.NullableLavalinkSessionTypeThe session of the node.NullableVoiceChannelUpdateTypeA type representing a partial update to the player's voice state.OmitTypeCreate a type that infers the value of a key from an object.PayloadOfTypeThe payload a filter takes: whatever {@link CustomizableFilters} declares for it, else the built-in shape from {@link FilterPayloads}, else `unknown` — so a filter nobody declared accepts any payload.PickNullableTypeMake a type nullable.PickRequiredTypeMake a type required.PlayerStorageAdapterStructureTypeThe structure for the PlayerStorageAdapter class.PlayerStructureTypeThe structure for the Player class.PlayerVoiceStateStructureTypeThe structure for the PlayerVoiceState class.PluginNameKeyTypeThe custom plugin name keys provided by users via module augmentation.PrettifyTypeThe type to prettify the object.QueueStructureTypeThe structure for the Queue class.RegistryCapabilityTypeThe full capability identifier accepted by the plugin registry.RegistryFilterNameTypeThe full filter name accepted by the filter registry.RegistryPluginNameTypeThe plugin name accepted by the plugin registry.RegistrySearchSourceTypeThe full source identifier accepted by the source registry.RegistrySourceNameTypeThe source name accepted by the source registry alias mapping.RequiredHoshimiNodeOptionsTypeThe required options for the node.RequiredHoshimiOptionsTypeThe required options for the manager.RestEndpointTypeThe REST endpoint type.RestOrArrayTypeCreate a type that can be a rest or an array.RestStructureTypeThe structure for the Rest class.SearchSourceTypeThe full source identifier accepted by the search API.SearchSourceKeyTypeThe custom search source keys provided by users via module augmentation.SourceNameTypeSource name type supporting built-ins plus custom augmented values.StorageKeysTypeType representing the customizable player storage.StorageValuesTypeType representing the customizable player storage values.TrackRequesterTypeThe requester of the track.TrackResolvableStructureTypeType representing a Hoshimi track, which can be either a resolved or unresolved track.TrackStructureTypeThe structure for the Track class.TrackUserDataTypeThe user data of the track.UnresolvedTrackInfoTypeThe type for the unresolved track info.UnresolvedTrackStructureTypeThe structure for the UnresolvedTrack class.UserAgentTypeThe type of the user agent for the requests.VoiceChannelUpdateTypeThe voice channel update options.VoiceDataUpdateTypeA type representing a partial update to the player's voice data.