Itee-Client

Global

Members

<constant> Byte :Enum

Byte allow semantic meaning of quantity of bytes based on power of two.
Type:
Properties:
Name Type Default Description
One Number 1 Octet
Two Number 2 Doublet
Four Number 4 Quadlet
Height Number 8 Octlet
Source:

<constant> Endianness :Enum

Endianness enum allow semantic usage.
Type:
Properties:
Name Type Default Description
Little Boolean true The Little endianess
Big Number false The Big endianess
Source:

<constant> Enum :object

A freezed javascript object used like an enum.
Type:
  • object
Source:
Example
var Meal = toEnum( {
    Food: 'Tartiflette',
    Drink: 'Saint-Emilion',
    Dessert: 'Mousse au chocolat'
} )

if( Foo.includes('Tartiflette') {
    // Happy
}

var myDrink = 'coke'
if( myDrink === Meal.Drink ) {

} else {
    // Your life is a pain
}

var MealTypes = Meal.types
// ['Tartiflette', 'Saint-Emilion', 'Mousse au chocolat' ]

<constant> FileFormat :Enum

The FileFormat Enum give some commonly used file format in 3d context
Type:
Properties:
Name Type Default Description
Asc String "asc" The ascii file format
Dae String "dae" The dae file format
Dbf String "dbf" The dbf file format
Fbx String "fbx" The fbx file format
Mtl String "mtl" The material file format
Json String "json" The json file format
Obj String "obj" The object file format
Shp String "shp" The shape file format
Stl String "stl" The stereolithographie file format
Source:

<constant> HttpStatusCode :Enum

HttpStatusCode contains all http status code available to check and process correctly server response.
Type:
Properties:
Name Type Default Description
Continue number 100 Waiting for the continuation of the request.
SwitchingProtocols number 101 The requester has asked the server to switch protocols and the server has agreed to do so.
Processing number 102 WebDAV: Processing in progress (prevents the client from exceeding the limited waiting time).
Ok number 200 Query successfully processed.
Created number 201 Query successfully processed and a document was created.
Accepted number 202 Query processed, but without guarantee of result.
NonAuthoritativeInformation number 203 Information returned, but generated by an uncertified source.
NoContent number 204 Query successfully processed but no information returned.
ResetContent number 205 Query successfully processed, the current page can be cleared.
PartialContent number 206 Only part of the resource has been transmitted.
MultiStatus number 207 WebDAV: Multiple Response.
AlreadyReported number 208 WebDAV: The document was previously sent to this collection.
ContentDifferent number 210 WebDAV: The copy of the client-side resource differs from that of the server (content or properties).
IMUsed number 226 The server has completed the request for the resource, and the response is a representation of the result of one or more instance manipulations applied to the current instance.
MultipleChoices number 300 The requested URI refers to multiple resources.
MovedPermanently number 301 Document moved permanently.
Found number 302 Document moved temporarily.
SeeOther number 303 The answer to this query is elsewhere.
NotModified number 304 Document not modified since the last request.
UseProxy number 305 The request must be re-addressed to the proxy.
Unused number 306 Code used by an older version of RFC 2616, now reserved.
TemporaryRedirect number 307 The request must be temporarily redirected to the specified URI.
PermanentRedirect number 308 The request must be redirected permanently to the specified URI.
TooManyRedirects number 310 The request must be redirected too many times, or is the victim of a redirection loop.
BadRequest number 400 The syntax of the query is wrong.
Unauthorized number 401 Authentication is required to access the resource.
PaymentRequired number 402 Payment required to access the resource.
Forbidden number 403 The server understood the request, but refuses to execute it. Unlike error 401, authenticating will not make any difference. On servers where authentication is required, this usually means that authentication has been accepted but access rights do not allow the client to access the resource.
NotFound number 404 Resource not found.
MethodNotAllowed number 405 Unauthorized request method.
NotAcceptable number 406 The requested resource is not available in a format that would respect the "Accept" headers of the request.
ProxyAuthenticationRequired number 407 Access to the authorized resource by identification with the proxy.
RequestTimeOut number 408 Waiting time for an elapsed client request.
Conflict number 409 The request can not be processed in the current state.
Gone number 410 The resource is no longer available and no redirection address is known.
LengthRequired number 411 The length of the request has not been specified.
PreconditionFailed number 412 Preconditions sent by the query unverified.
RequestEntityTooLarge number 413 Abandoned processing due to excessive request
RequestURITooLong number 414 URI too long
UnsupportedMediaType number 415 Unsupported query format for a given method and resource.
RequestRangeUnsatisfiable number 416 Invalid "range" request header fields.
ExpectationFailed number 417 Expected behavior and defined in the header of the unsatisfactory request.
ImATeapot number 418 "I am a teapot". This code is defined in RFC 2324 dated April 1, 1998, Hyper Text Coffee Pot Control Protocol.
BadMapping number 421 The request was sent to a server that is not able to produce a response (for example, because a connection has been reused).
UnprocessableEntity number 422 WebDAV: The entity provided with the request is incomprehensible or incomplete.
Locked number 423 WebDAV: The operation can not take place because the resource is locked.
MethodFailure number 424 WebDAV: A method of the transaction failed.
UnorderedCollection number 425 WebDAV RFC 3648. This code is defined in the WebDAV Advanced Collections Protocol draft , but is absent from the Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol.
UpgradeRequired number 426 RFC 2817 The client should change protocol, for example to TLS / 1.0 .
PreconditionRequired number 428 RFC 6585 The request must be conditional.
TooManyRequests number 429 RFC 6585 The client has issued too many requests within a given time.
RequestHeaderFieldsTooLarge number 431 RFC 6585 HTTP headers issued exceed the maximum size allowed by the server.
NoResponse number 444 Indicates that the server did not return any information to the client and closed the connection.
RetryWith number 449 Code defined by Microsoft . The request should be returned after performing an action.
BlockedByWindowsParentalControls number 450 Code defined by Microsoft. This error is generated when Windows Parental Control tools are enabled and block access to the page.
UnavailableForLegalReasons number 451 This error code indicates that the requested resource is inaccessible for legal reasons
UnrecoverableError number 456 WebDAV: Fatal error.
SSLCertificateError number 495 An extension of the 400 Bad Request error, used when the client provided an invalid certificate.
SSLCertificateRequired number 496 An extension of the 400 Bad Request error, used when a required client certificate is not provided.
HTTPRequestSentToHTTPSPort number 497 An extension of the 400 Bad Request error, used when the client sends an HTTP request to port 443 normally intended for HTTPS requests.
ClientClosedRequest number 499 The client closed the connection before receiving the response. This error occurs when the processing is too long on the server side.
InternalServerError number 500 Internal server error.
NotImplemented number 501 Functionality claimed not supported by the server.
BadGateway number 502 Wrong response sent to an intermediate server by another server.
ServiceUnavailable number 503 Service temporarily unavailable or under maintenance.
GatewayTimeOut number 504 Waiting time for a response from a server to an intermediate server that has elapsed.
HTTPVersionNotSupported number 505 HTTP version not managed by the server.
VariantAlsoNegotiates number 506 RFC 2295: Negotiation Error. Transparent content negociation.
InsufficientStorage number 507 WebDAV: Insufficient space to modify properties or build the collection.
LoopDetected number 508 WebDAV: Loop in a Resource Match
BandwidthLimitExceeded number 509 Used by many servers to indicate a quota overrun.
NotExtended number 510 RFC 2774: The request does not respect the policy for accessing extended HTTP resources.
NetworkAuthenticationRequired number 511 RFC 6585: The client must authenticate to access the network. Used by captive portals to redirect clients to the authentication page.
UnknownError number 520 Error 520 is used as a wildcard response when the origin server returns an unexpected result.
WebServerIsDown number 521 The server has refused the connection from Cloudflare.
ConnectionTimedOut number 522 Cloudflare could not negotiate a TCP handshake with the origin server.
OriginIsUnreachable number 523 Cloudflare failed to reach the origin server. This can occur if DNS server name resolution fails.
ATimeoutOccured number 524 Cloudflare established a TCP connection with the origin server but did not receive an HTTP response before the login timeout.
SSLHandshakeFailed number 525 Cloudflare could not negotiate SSL / TLS handshake with the origin server.
InvalidSSLCertificate number 526 Cloudflare could not validate the SSL certificate presented by the origin server.
RailgunError number 527 Error 527 indicates that the request has timed out or failed after the WAN connection was established.
Source:
See:

<constant> HttpVerb :Enum

HttpVerb contains the CRUD actions with corresponding http verb to request an itee server.
Type:
Properties:
Name Type Default Description
Create String "PUT" Corresponding to the create http verb for an itee server, namely "PUT".
Read String "POST" Corresponding to the read http verb for an itee server, namely "POST".
Update String "PATCH" Corresponding to the update http verb for an itee server, namely "PATCH".
Delete String "DELETE" Corresponding to the delete http verb for an itee server, namely "DELETE".
Source:
See:

<constant> Keys :Enum

Keys contains common keyboard key values, this allow to write semantic code instead of integer when dealing with key codes.
Type:
Properties:
Name Type Default Description
BACKSPACE Number 8 The backspace key code
TAB Number 9 The tab key code
ENTER Number 13 The enter key code
Etc... Number * All the rest
Source:

<constant> MimeType :Enum

Todo...
Type:
Properties:
Name Type Description
... Number
Source:

<constant> Mouse :Enum

This Mouse Enum expose 4 common state of mouse button values (Wheel, Left, Middle and Right), this allow to write semantic code instead of integer when dealing with mouse button codes.
Type:
Properties:
Name Type Default Description
Wheel Number -1 The enter key code
Left Number 0 The enter key code
Middle Number 1 The enter key code
Right Number 2 The enter key code
Source:

<constant> RequestType :ReadonlyArray.<unknown>

Type:
  • ReadonlyArray.<unknown>
Source:

<constant> ResponseType :Enum

ResponseType allow to filter wich type of response is recieved from the server.
Type:
Properties:
Name Type Default Description
ArrayBuffer String "arraybuffer" The "arraybuffer" server response type.
Blob String "blob" The "blob" server response type.
Document String "document" The "document" server response type.
Json String "json" The "json" server response type.
DOMString String "text" The "text" server response type.
Default String "text" The "" server response type ( equivalent to DOMString ).
Source:
See:

<constant> TIdFactoryType :ReadonlyArray.<unknown>

Type:
  • ReadonlyArray.<unknown>
Deprecated:
  • Yes
Source:

Methods

npm run bench()

Will run benchmarks using karma
Source:

npm run build()

Build css and javascript files
Source:

npm run build-script()

Will build itee client module using optional arguments. See help to further informations.
Source:

npm run build-test()

Will build itee client tests.
Source:

npm run clean()

Will delete builds and temporary folders
Source:

npm run doc()

Will generate this documentation
Source:

npm run help ()

Will display the help in console
Source:

npm run lint()

Will lint the sources files and try to fix the style when possible
Source:

npm run patch()

Will apply some patch/replacements in dependencies
Source:

npm run release()

Will perform a complet release of the library including 'clean', 'lint', 'doc', 'build-test', 'test' and finally 'build'.
Source:

npm run test()

Will run unit tests and benchmarks using karma
Source:

npm run unit()

Will run unit tests using karma
Source:

Type Definitions

AllowedOrigin

A POJO object containg datas about a distant source to allow
Type:
  • Object
Properties:
Name Type Description
id string The id to reference this origin as a human readable string
uri string The uri of the origin to allow
methods Array.<String> An array of methods names that are allowed for this origins. To allow all methods use '*', in case no methods string were provide the origin won't be able to do anything.
Source:

WebAPIMessageDataSerialized

Type:
  • Object
Properties:
Name Type Description
data object
Source:

WebAPIMessageSerialized

Type:
  • Object
Properties:
Name Type Description
id string
type string
Source: