discord-player 6.6.7-dev.0 → 6.6.8-dev.0

package/dist/index.d.ts

@@ -2849,22 +2849,93 @@ declare class QueryResolver {
     static validateURL(q: string): boolean;
 }
 
+type unsafe = any;
+/**
+ * The receiver function that will be called when the context is provided
+ */
+type ContextReceiver<R> = () => R;
+/**
+ * The props for the context provider
+ */
+interface ContextProviderProps<T, R> {
+    /**
+     * The value to provide
+     */
+    value: T;
+    /**
+     * The receiver function that will be called when the context is provided
+     */
+    receiver: ContextReceiver<R>;
+}
+declare class Context<T> {
+    private defaultValue?;
+    private storage;
+    constructor(defaultValue?: T | undefined);
+    /**
+     * Exit out of this context
+     */
+    exit(scope: ContextReceiver<void>): void;
+    /**
+     * Whether the context is lost
+     */
+    get isLost(): boolean;
+    /**
+     * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
+     */
+    getValue(): T | undefined;
+    /**
+     * Run a function within the context of this provider
+     */
+    provide<R = unsafe>({ receiver, value }: ContextProviderProps<T, R>): R;
+}
+/**
+ * Create a new context. The default value is optional.
+ * @param defaultValue The default value of the context
+ * @example const userContext = createContext();
+ *
+ *  // the value to provide
+ *  const user = {
+ *   id: 1,
+ *   name: 'John Doe'
+ *  };
+ *
+ *  // provide the context value to the receiver
+ *  context.provide({ value: user, receiver: handler });
+ *
+ *  function handler() {
+ *    // get the context value
+ *    const { id, name } = useContext(context);
+ *
+ *    console.log(id, name); // 1, John Doe
+ *  }
+ */
+declare function createContext<T = unsafe>(defaultValue?: T): Context<T>;
+/**
+ * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
+ * @param context The context to get the value from
+ * @example const value = useContext(context);
+ */
+declare function useContext<T = unsafe>(context: Context<T>): T | undefined;
+
 /**
  * Fetch guild queue history
  * @param node guild queue node resolvable
  */
+declare function useHistory<Meta = unknown>(): GuildQueueHistory<Meta> | null;
 declare function useHistory<Meta = unknown>(node: NodeResolvable): GuildQueueHistory<Meta> | null;
 
 /**
  * Fetch guild queue player node
  * @param node Guild queue node resolvable
  */
+declare function usePlayer<Meta = unknown>(): GuildQueuePlayerNode<Meta> | null;
 declare function usePlayer<Meta = unknown>(node: NodeResolvable): GuildQueuePlayerNode<Meta> | null;
 
 /**
  * Fetch guild queue
  * @param node Guild queue node resolvable
  */
+declare function useQueue<Meta = unknown>(): GuildQueue<Meta> | null;
 declare function useQueue<Meta = unknown>(node: NodeResolvable): GuildQueue<Meta> | null;
 
 /**
@@ -2878,11 +2949,13 @@ declare function useMasterPlayer(): Player;
 declare function useMainPlayer(): Player;
 
 type SetterFN$1<T, P> = (previous: P) => T;
+type MetadataDispatch<T> = readonly [() => T, (metadata: T | SetterFN$1<T, T>) => void];
 /**
  * Fetch or manipulate guild queue metadata
  * @param node Guild queue node resolvable
  */
-declare function useMetadata<T = unknown>(node: NodeResolvable): readonly [() => T, (metadata: T | SetterFN$1<T, T>) => void];
+declare function useMetadata<T = unknown>(): MetadataDispatch<T>;
+declare function useMetadata<T = unknown>(node: NodeResolvable): MetadataDispatch<T>;
 
 interface TimelineDispatcherOptions {
     ignoreFilters: boolean;
@@ -2892,7 +2965,7 @@ interface TimelineDispatcherOptions {
  * @param node Guild queue node resolvable
  * @param options Options for timeline dispatcher
  */
-declare function useTimeline(node: NodeResolvable, options?: Partial<TimelineDispatcherOptions>): {
+declare function useTimeline(node?: NodeResolvable, options?: Partial<TimelineDispatcherOptions>): {
     readonly timestamp: PlayerTimestamp;
     readonly volume: number;
     readonly paused: boolean;
@@ -2916,11 +2989,13 @@ declare function onAfterCreateStream(handler: OnAfterCreateStreamHandler): void;
 declare function onBeforeCreateStream(handler: OnBeforeCreateStreamHandler): void;
 
 type SetterFN = (previous: number) => number;
+type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boolean | undefined];
 /**
  * Fetch or manipulate player volume
  * @param node Guild queue node resolvable
  */
-declare function useVolume(node: NodeResolvable): readonly [() => number, (volume: number | SetterFN) => boolean | undefined];
+declare function useVolume(): VolumeDispatch;
+declare function useVolume(node: NodeResolvable): VolumeDispatch;
 
 declare const instances: Collection<string, Player>;
 
@@ -2936,4 +3011,4 @@ declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, HookDeclaration, HookDeclarationContext, IPBlock, IPRotationConfig, IPRotator, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResolvedQuery, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SerializedPlaylist, SerializedTrack, SerializedType, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextProviderProps, ContextReceiver, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, HookDeclaration, HookDeclarationContext, IPBlock, IPRotationConfig, IPRotator, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResolvedQuery, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };