Home
Guides
GitHub
npm
Preparing search index...
The search index is not available
sxcu.api - v2.0.6
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
sxcu.api
createCollection
Function createCollection
create
Collection
(
title
,
options
?
)
:
Promise
<
CreatedCollection
>
Create a collection.
Parameters
title
:
string
The title of this collection.
Optional
options
:
CreateCollectionOptions
Collection creation options.
Returns
Promise
<
CreatedCollection
>
Home
Guides
GitHub
npm
sxcu.api -
v2.0.6
Snowflake
Object
Flag
All possible strings of a snowflake object flag.
Snowflake
Object
Type
All possible strings of a snowflake object type.
User
Agent
Class
Web request user agent class.
Collection
Meta
A collections meta information.
Converted
Sxcu
File
Represents a converted sxcu file.
Create
Collection
Options
Available options that can be provided when creating a collection.
Created
Collection
Represents a created collection.
Deletion
Token
A deletion token which is required when deleting something.
Endpoint
Available endpoints.
Error
Object
An error object.
File
Collection
Meta
A file in a collection meta.
File
Data
A file but with less data associated with it.
File
Meta
Represents the meta data of a file.
File
Options
Represents file options which can be utilized in `uploadFile`.
Link
A link object.
Parsed
Snowflake
The data extracted from a snowflake.
Paste
A paste object.
Rate
Limit
Represents a rate limit.
Request
Options
Request options.
Snowflake
Represents a snowflake.
Subdomain
Represents a subdomain.
Subdomain
Data
A subdomain but with less data associated with it.
Token
A token which is required when performing an action.
Uploadable
File
Represents what is considered an uploadable file.
Url
Represents a url.
User
Agent
User agent used for all requests.
categorize
Imports
Categorize imports into their respective categories.
check
Subdomain
Check if a subdomain exists.
convert
Sxcu
File
Convert an sxcu file to a useable object.
create
Collection
Create a collection.
create
Error
Create an error code.
create
Link
Create a link.
create
Paste
Create a paste.
delete
File
Delete a file.
delete
Link
Delete a link.
delete
Paste
Delete a paste.
extract
Token
Extracts the token or id from a url or path.
get
Collection
Meta
Get the meta information of a collection.
get
File
Meta
Get the meta information of a file.
get
Rate
Limits
Returns a copy of the object containing all stored rate limits.
get
Subdomain
Meta
Get the meta data of a subdomain.
list
Subdomains
Get a list of all subdomains.
parse
Snowflake
Get the data associated with a snowflake.
promisify
Endpoint
Rate
Limit
A wrapper for promisifyRateLimit that uses an endpoint's rate limit as the first argument.
promisify
Global
Rate
Limit
A wrapper for promisifyRateLimit that uses the global rate limit as the first argument.
promisify
Rate
Limit
Returns a promise that resolves once the rate limit is over.
request
Create an API request.
resolve
Error
Attempt to resolve an error from "thing".
toggle
Request
Queue
Toggle the request queue.
upload
File
Upload a file.
Create a collection.