HBO-ICT.Cloud
NPM
Source
Preparing search index...
The search index is not available
@hboictcloud/api - v1.0.1
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
@hboictcloud/api
types
ApiFailResponse
Interface ApiFailResponse
Represents a failed response from the API
Hierarchy
ApiFailResponse
Index
Properties
reason
Properties
reason
reason
:
string
Reason why the response failed
On This Page
reason
@hboictcloud/api -
v1.0.1
api
API-extension for the HBO-ICT.Cloud library
configure
Configure the HBO-ICT.Cloud API
query
Database
Send an SQL-query to the configured database
send
Email
Send an email
upload
File
Upload a file to the uploads-folder on the configured HBO-ICT.Cloud environment
delete
File
Delete a file from the uploads-folder on the configured HBO-ICT.Cloud environment
file
Exists
Checks if a file exists inside the uploads-folder on the configured HBO-ICT.Cloud environment.
delete
Directory
Delete a directory from the uploads-folder on the configured HBO-ICT.Cloud environment, but only when it is empty.
list
Directory
List all files and directories inside a directory, inside the uploads-folder on the configured HBO-ICT.Cloud environment.
directory
Exists
Checks if a directory exists inside the uploads-folder on the configured HBO-ICT.Cloud environment.
localization
Localization-extension for the HBO-ICT.Cloud library
set
Translations
Register all the translations to localize a webpage
register
Translate
Attribute
Register additional attributes which should be translated whenever translate is called.
switch
Language
Switch the active language, will be immediately applied.
translate
Apply the translations for the active language, useful for dynamic changes on a webpage.
session
Session-extension for the HBO-ICT.Cloud library
get
All
Get all keys from the session as an object
get
Get a specific key from the session. If you need multiple keys from the session, it's better to use getAll instead.
set
Set a specific key in the session
remove
Remove a specific key from the session
clear
Remove all data from the session
types
Shared types for the HBO-ICT.Cloud library
Api
Fail
Reason
Type definition to make a clear distinction between successful and failed responses in the documentation
Promise
Resolve
Type definition of function used to resolve a promise
Promise
Reject
Type definition of function used to reject a promise
Api
Fail
Response
Represents a failed response from the API
Non
Query
Result
Represents a non-query result from the database
Query
String
Object
Represents a querystring as an object
Options
Holds all options for the HBO-ICT.Cloud API
Email
Address
Represents a single email contact
Email
Represents an email. Is only considered valid when all required fields are provided and either text or html have a value.
DataURL
Represents the Data-URL of a file
url
URL-extension for the HBO-ICT.Cloud library
get
Query
String
As
Object
Get the querystring as an object
get
From
Query
String
Get a specific key from the querystring. If you need multiple keys from the querystring, it's better to use getQueryStringAsObject instead.
redirect
Redirect the browser to a new URL, leaving the current URL in the back/forward browser-history.
replace
Replace the URL visible in the browser, also replacing the current URL in the back/forward browser-history. Doesn't actually redirect the page, just updates the URL.
utils
Utils-extension for the HBO-ICT.Cloud library
get
Data
Url
Convert a file-input to a Data-URL
create
Url
Create a URL with a querystring
random
String
Generate a `string` of random characters
to
Sql
Date
Time
Convert a Date-object to an SQL accepted String-format
copy
Object
Create a copy of a object
create
Query
String
Create a querystring of all keys in a given object
parse
Query
String
Parse all keys of a given querystring to an object
parse
Html
Parse a `string` containing HTML to a list of HTML elements
fetch
And
Parse
Html
Download a file from a given URL as text and parse it to a list of HTML elements
fetch
Text
Download a file from a given URL as text
fetch
Json
Download a file from a given URL as JSON
fetch
Blob
Download a file from a given URL as a blob
Generated using
TypeDoc
Represents a failed response from the API