Typescript-request NPM

typescript-request

Typescript library to easy use XMLHttpRequest

Installation

npm install typescript-request

How to use directly in HTML project

<!DOCTYPE html>
<html>
<head>
    <!-- USE LINES ABOVE IF Uncaught ReferenceError: exports is not defined IN CONSOLE -->
    <!-- DO NOT USE THIS IN WEBPACK or GULP BROWSERIFY/TSIFY PROJECTS -->
    <script>
        var exports = {};
    </script>
    <!-- END USE -->
    <!-- END THIS ERROR -->

    <script src="lib/request.js"></script>

    <script>
        const successUrl = 'https://github.com/djpatzo/typescript-request/success-request.json';
        const errorUrl = './not-exists.json';

        window.addEventListener('load', function() {
            document.write('<h4>Check developers console!!!</h4>')
            /**
             * Success request
             */
            new TSRequest(successUrl, 'GET', [], {
                onReady: function (responseData) {
                    console.info('Ready success', responseData);
                },
                onSuccess: function(responseData) {
                    console.log('Success', responseData);
                }
            });

            /**
             * Error request
             */
            new TSRequest(errorUrl, 'GET', [], {
                onReady: function (responseData) {
                    console.info('Ready error');
                },
                onError: function (responseData) {
                    console.error('Error');

                    //document.write('Error: ', JSON.stringify(responseData));
                }
            });
        });
    </script>
</head>
<body>
</body>
</html>

How to use in TypeScript Project

import TSRequest from 'typescript-request';

const url: string = 'https://github.com/djpatzo/typescript-request/success-request.json';

new TSRequest(successUrl, 'GET', [], {
  onReady: function (responseData) {
    console.info('Ready success');
  },
  onSuccess: function(responseData) {
    console.log('Success', responseData);
  }
});

Initialization

TSRequest(..arguments)	Type	Description
url	string (required)	Required. The 'url' is required to make request
method	string (default:'GET')	Optional. If you want to set headers or options, you must set this string. Available are standard HTTP methods, eg. GET, POST, PUT, DELETE, etc.
headers	Array\ (default:[])	Optional. See src/HeadersInterface.ts Every item in array must be object with name and value keys. Here we must use standard HTTP Headers. Eg. { name: 'Header-Name', value: 'Value of header' }, { name: 'Header-Name-2', value: 'Value of header 2' }
options	object (default:{}) see options parameters	Optional. Every item in array must be object with name and value keys. Here we must use standard HTTP Headers. Eg. { name: 'Header-Name', value: 'Value of header' }, { name: 'Header-Name-2', value: 'Value of header 2' }

options

By default, TSRequest uses only four parameters

const defaultOptions: any = {
  postData: null,
  onReady: null,
  onError: null,
  onSuccess: null
};

options parameters

postData is required only with method 'POST' in constructor

onReady is executed everytime where XMLHttpRequest readyState is 4 (end request)

onSuccess is executed everytime where HTTP Response Code is 200

onError is executed everytime where HTTP Response Code is not 200

TypeScript Request

abab agent-base ansi-escapes ansi-regex ansi-styles anymatch asynckit acorn-walk argparse babel-plugin-istanbul acorn balanced-match acorn-globals brace-expansion babel-preset-current-node-syntax braces browser-process-hrtime bs-logger babel-jest babel-preset-jest buffer-from callsites babel-plugin-jest-hoist camelcase char-regex browserslist chalk ci-info cjs-module-lexer cliui co collect-v8-coverage color-convert color-name combined-stream commander concat-map convert-source-map bser cross-spawn cssom cssstyle data-urls caniuse-lite debug decimal.js dedent deepmerge builtin-modules delayed-stream detect-newline diff diff-sequences domexception emittery emoji-regex escalade escape-string-regexp esprima execa electron-to-chromium escodegen exit deep-is expect fast-json-stable-stringify fast-levenshtein fb-watchman fill-range find-up fs.realpath form-data function-bind gensync get-caller-file esutils get-stream estraverse globals glob has has-flag html-encoding-sniffer graceful-fs http-proxy-agent https-proxy-agent human-signals iconv-lite import-local get-package-type imurmurhash inflight inherits is-core-module is-fullwidth-code-point is-generator-fn is-number is-stream is-potential-custom-element-name html-escaper is-typedarray isexe istanbul-lib-instrument istanbul-lib-coverage istanbul-lib-report istanbul-lib-source-maps istanbul-reports jest-changed-files jest-circus jest-cli jest-config jest-diff jest-each jest-docblock jest-environment-jsdom jest-environment-node jest-get-type jest-haste-map jest-jasmine2 jest-leak-detector jest-matcher-utils jest-message-util jest-mock jest-pnp-resolver jest-resolve jest-regex-util jest-runner jest-resolve-dependencies jest-runtime jest-serializer jest-snapshot jest-validate jest-util jest-watcher jest-worker js-tokens js-yaml jsdom jsesc json5 kleur leven locate-path lodash lodash.memoize lru-cache make-error makeerror merge-stream micromatch mime-db mime-types levn mimic-fn minimatch minimist make-dir mkdirp ms node-modules-regexp natural-compare normalize-path npm-run-path nwsapi once onetime p-limit p-locate p-try path-exists node-int64 parse5 path-is-absolute path-key optionator picomatch node-releases pirates pkg-dir pretty-format prompts psl react-is path-parse require-directory resolve resolve-cwd resolve.exports resolve-from picocolors rimraf punycode safe-buffer prelude-ls safer-buffer saxes semver shebang-command shebang-regex signal-exit slash source-map source-map-support stack-utils string-length string-width strip-ansi strip-bom strip-final-newline sisteransi supports-color supports-hyperlinks sprintf-js symbol-tree terminal-link throat tmpl to-fast-properties to-regex-range tr46 tough-cookie tslib tsutils type-detect typedarray-to-buffer type-fest universalify v8-to-istanbul w3c-hr-time w3c-xmlserializer walker webidl-conversions whatwg-encoding test-exclude type-check whatwg-mimetype whatwg-url which wrap-ansi wrappy write-file-atomic ws xml-name-validator xmlchars y18n yallist yargs yargs-parser word-wrap

@infinitebrahmanuniverse/nolb-typescript-r @everything-registry/sub-chunk-2998

1.0.0-alpha

2 years ago

1.0.0

2 years ago