Skip to content

SearchOptions

Property Type Description
allowAgeRestricted? boolean false when the caller refuses age-restricted Songs: leave them out where the provider can, such as with a provider’s safe search. DisTube still drops results marked ageRestricted: true. Absent when DisTube checks the picked Song itself, as play with a query and the search fallback do.
limit number Positive. A plugin clamps it to its own maximum.
offset number Zero-based index of the first result.
report PluginReport -
signal AbortSignal -