Response Types

ksoft.js
Search…
ksoft.js
KSoft.js
Endpoints
Response Types
This is an alphabetic listing of all response types.
Album
1
interface Album {
2
    name: string;
3
    id?: string;
4
    year: number;
5
    artist?: Artist;
6
    tracks?: Track[];
7
}
Copied!
Artist
1
interface Artist {
2
    name: string;
3
    id?: string;
4
    albums?: Album[];
5
    tracks?: Track[];
6
}
Copied!
Ban
1
interface Ban {
2
    user: BannedUser;
3
    moderator: string;
4
    reason: string;
5
    proof: string
6
    active: boolean;
7
    appealable: boolean;
8
    
9
    setUser(id: string, name: string, discriminator: string): Ban;
10
    setUser(user: Discord.User): Ban;
11
    setModerator(id: string): Ban;
12
    setReason(reason: string, proof: string): Ban;
13
}
Copied!
BanAPIResponse
1
interface BanAPIResponse {
2
    success: boolean;
3
    message?: string;
4
}
Copied!
BannedUser
1
interface BannedUser {
2
    id: string;
3
    username?: string;
4
    discriminator?: string;
5
}
Copied!
Conversion
1
interface Conversion {
2
    value: number;
3
    pretty: string;
4
}
Copied!
Image
1
interface Image {
2
    tag?: Tag;
3
    url: string;
4
    id?: string;
5
}
Copied!
IPReport
1
interface IPReport {
2
    location: Location;
3
    map: string; // URL, Google Maps
4
}
Copied!
Location
1
interface Location {
2
    lat: number;
3
    lon: number;
4
    address: string;
5
}
Copied!
RedditImage
1
interface RedditImage extends Image {
2
    post: RedditPost;
3
}
Copied!
RedditPost
1
interface ReditPost {
2
    title: string;
3
    subreddit: string;
4
    link: string;
5
    upvotes: number;
6
    downvotes: number;
7
    author: string;
8
    comments: number;
9
}
Copied!
SpotifyAlbum
1
interface SpotifyAlbum {
2
    title: string;
3
    link: string;
4
    art: string;
5
}
Copied!
SpotifyArtist
1
interface SpotifyArtist {
2
    name: string;
3
    link: string;
4
}
Copied!
SpotifyTrack
1
interface SpotifyTrack {
2
    id: string;
3
    link: string;
4
    title: string;
5
    album: SpotifyAlbum;
6
    artists: SpotifyArtist[];
7
}
Copied!
Suggestion
1
interface Suggestion {
2
    title: string;
3
    youtube: YouTubeTrack;
4
    spotify: SpotifyTrack;
5
}
Copied!
Tag
1
interface Tag {
2
    name: string;
3
    nsfw: boolean;
4
}
Copied!
Track
1
interface Track {
2
    name: string;
3
    id: string;
4
    artist?: Artist;
5
    albums?: Album[];
6
    lyrics: string;
7
    url: string;
8
}
Copied!
WeatherReport
1
interface WeatherReport {
2
    location: Location;
3
    icon: string;
4
    summary: string;
5
    temperature: number;
6
    uvIndex: number;
7
    humidity: number;
8
    pressure: number;
9
    precipPossibility: number;
10
}
Copied!
WikiHowArticle
1
interface WikiHowArticle {
2
    title: string;
3
    link: string;
4
}
Copied!
WikiHowImage
1
interface WikiHowImage extends Image {
2
    article: WikiHowArticle;
3
}
Copied!
YouTubeTrack
1
interface YouTubeTrack {
2
    id: string;
3
    link: string;
4
    title: string;
5
    thumbnail: string;
6
    description: string;
7
}
Copied!
KSoft.js
Next - Endpoints
Images
Last modified 8mo ago