soundcloud.ts
Version:
Soundcloud API v2 wrapper with typings.
40 lines (39 loc) • 1.4 kB
TypeScript
import type { SoundcloudTrack, SoundcloudUserFilter, SoundcloudUserSearch, SoundcloudUser, SoundcloudWebProfile } from "../types";
import { API } from "../API";
export declare class Users {
private readonly api;
private readonly resolve;
constructor(api: API);
/**
* Searches for users using the v2 API.
*/
search: (params?: SoundcloudUserFilter) => Promise<SoundcloudUserSearch>;
/**
* Fetches a user from URL or ID using Soundcloud v2 API.
*/
get: (userResolvable: string | number) => Promise<SoundcloudUser>;
/**
* Gets all the tracks by the user using Soundcloud v2 API.
*/
tracks: (userResolvable: string | number) => Promise<SoundcloudTrack[]>;
/**
* Gets all of a users liked tracks.
*/
likes: (userResolvable: string | number, limit?: number) => Promise<SoundcloudTrack[]>;
/**
* Gets all the web profiles on a users sidebar.
*/
webProfiles: (userResolvable: string | number) => Promise<SoundcloudWebProfile[]>;
/**
* Gets a user's followers.
*/
following: (userResolvable: string | number, limit?: number) => Promise<SoundcloudUser[]>;
/**
* Searches for users (web scraping)
*/
searchAlt: (query: string) => Promise<SoundcloudUser[]>;
/**
* Gets a user by URL (web scraping)
*/
getAlt: (url: string) => Promise<SoundcloudUser>;
}