README.md

soundcloud-fetch

soundcloud-fetch

Table of contents

Namespaces

• Constants

Classes

• Album
• Collection
• CollectionContinuation
• Entity
• LibraryItem
• Like
• MediaTranscoding
• PlayHistoryItem
• Playlist
• Publisher
• Selection
• Set
• SoundCloud
• SystemPlaylist
• Track
• User

Interfaces

• EntityConstructor
• GetCollectionOptions
• SoundCloudInitArgs

Type Aliases

• ArtworkImageUrls
• AvatarImageUrls
• CollectionOptions
• EntityClasses
• EntityClassesToTypes
• EntityType

Functions

• getEntityClassByName
• getEntityClassName

Type Aliases

ArtworkImageUrls

Ƭ ArtworkImageUrls: Object

Type declaration

Name	Type
badge?	string
crop?	string
default	string
large?	string
mini?	string
small?	string
t300x300?	string
t500x500?	string
t67x67?	string
tiny?	string

Defined in

lib/entities/Entity.ts:19

---

AvatarImageUrls

Ƭ AvatarImageUrls: Object

Type declaration

Name	Type
badge?	string
crop?	string
default	string
large?	string
mini?	string
small?	string
t300x300?	string
t500x500?	string
tiny?	string

Defined in

lib/entities/Entity.ts:8

---

CollectionOptions

Ƭ CollectionOptions<T>: { asType?: undefined ; requireTypes?: EntityClasses<T> } | { asType: EntityConstructor<T> ; requireTypes?: undefined }

Type parameters

Name	Type
T	extends EntityType

Defined in

lib/collections/Collection.ts:6

---

EntityClasses

Ƭ EntityClasses<T>: EntityConstructor<T> | EntityConstructor<T>[]

Type parameters

Name	Type
T	extends EntityType

Defined in

lib/utils/EntityTypes.ts:27

---

EntityClassesToTypes

Ƭ EntityClassesToTypes<K>: K extends EntityConstructor<infer U> ? U : K extends EntityConstructor<infer U>[] ? U : never

Type parameters

Name
K

Defined in

lib/utils/EntityTypes.ts:30

---

EntityType

Ƭ EntityType: Album | Playlist | Selection | SystemPlaylist | Track | User | Like | PlayHistoryItem | LibraryItem

Defined in

lib/utils/EntityTypes.ts:11

Functions

getEntityClassByName

▸ getEntityClassByName(name): null | typeof Playlist | typeof User | typeof Track | typeof Like | typeof SystemPlaylist | typeof Selection | typeof PlayHistoryItem | typeof LibraryItem

Parameters

Name	Type
name	string

Returns

null | typeof Playlist | typeof User | typeof Track | typeof Like | typeof SystemPlaylist | typeof Selection | typeof PlayHistoryItem | typeof LibraryItem

Defined in

lib/utils/EntityTypes.ts:59

---

getEntityClassName

▸ getEntityClassName<T>(value): null | string

Type parameters

Name	Type
T	extends EntityType

Parameters

Name	Type
value	EntityConstructor<T>

Returns

null | string

Defined in

lib/utils/EntityTypes.ts:49