Skip to content

SearchRequest

Options for distube.search. source narrows the result type to that plugin’s data.

Type Parameter Default type
Source extends Plugin Plugin
Property Type Default value Description
allowAgeRestricted? boolean false Unless true, asks each plugin to leave age-restricted results out, as YouTube’s restricted mode does, and leaves out results whose ageRestricted is true. Results whose answer is unknown stay; play checks them.
limit? number undefined Positive integer, default 10.
offset? number undefined Non-negative integer, default 0.
signal? AbortSignal undefined -
source? Source undefined -