Type Alias Url

Url: string

Represents a url.

Defined in types.ts:8

Home Guides GitHub npm

sxcu.api - v2.0.6

SnowflakeObjectFlag
All possible strings of a snowflake object flag.
SnowflakeObjectType
All possible strings of a snowflake object type.
UserAgentClass
Web request user agent class.
CollectionMeta
A collections meta information.
ConvertedSxcuFile
Represents a converted sxcu file.
CreateCollectionOptions
Available options that can be provided when creating a collection.
CreatedCollection
Represents a created collection.
DeletionToken
A deletion token which is required when deleting something.
Endpoint
Available endpoints.
ErrorObject
An error object.
FileCollectionMeta
A file in a collection meta.
FileData
A file but with less data associated with it.
FileMeta
Represents the meta data of a file.
FileOptions
Represents file options which can be utilized in `uploadFile`.
Link
A link object.
ParsedSnowflake
The data extracted from a snowflake.
Paste
A paste object.
RateLimit
Represents a rate limit.
RequestOptions
Request options.
Snowflake
Represents a snowflake.
Subdomain
Represents a subdomain.
SubdomainData
A subdomain but with less data associated with it.
Token
A token which is required when performing an action.
UploadableFile
Represents what is considered an uploadable file.
Url
Represents a url.
UserAgent
User agent used for all requests.
categorizeImports
Categorize imports into their respective categories.
checkSubdomain
Check if a subdomain exists.
convertSxcuFile
Convert an sxcu file to a useable object.
createCollection
Create a collection.
createError
Create an error code.
createLink
Create a link.
createPaste
Create a paste.
deleteFile
Delete a file.
deleteLink
Delete a link.
deletePaste
Delete a paste.
extractToken
Extracts the token or id from a url or path.
getCollectionMeta
Get the meta information of a collection.
getFileMeta
Get the meta information of a file.
getRateLimits
Returns a copy of the object containing all stored rate limits.
getSubdomainMeta
Get the meta data of a subdomain.
listSubdomains
Get a list of all subdomains.
parseSnowflake
Get the data associated with a snowflake.
promisifyEndpointRateLimit
A wrapper for promisifyRateLimit that uses an endpoint's rate limit as the first argument.
promisifyGlobalRateLimit
A wrapper for promisifyRateLimit that uses the global rate limit as the first argument.
promisifyRateLimit
Returns a promise that resolves once the rate limit is over.
request
Create an API request.
resolveError
Attempt to resolve an error from "thing".
toggleRequestQueue
Toggle the request queue.
uploadFile
Upload a file.