# ts-axios-demo > axios with typescript Latest version **0.1.3** (published 2019-06-23) · MIT license · 0 weekly downloads ## Install ```sh npm install ts-axios-demo pnpm add ts-axios-demo yarn add ts-axios-demo bun add ts-axios-demo ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.3 | | Published | 2019-06-23 | | First published | 2019-06-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=6.0.0 | | Dependencies | 0 | | Unpacked size | 262.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | newming | | Maintainers | newming | | Keywords | typescript, axios | ## Links - npm: https://www.npmjs.com/package/ts-axios-demo - Repository: https://github.com/newming/ts-axios - Homepage: https://github.com/newming/ts-axios#readme - Issues: https://github.com/newming/ts-axios/issues - npm.io page: https://npm.io/package/ts-axios-demo ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 0.1.3 (latest) — 2019-06-23 - 0.1.2 — 2019-06-23 - 0.1.1 — 2019-06-23 ## README # typescript实现axios ## Use same with [axios](https://github.com/axios/axios) ## 安装 ```bash npm i -g typescript tsc --version # 3.4.6 tsc [name].ts # 进行编译 tsc [name].ts --target es5 # 编译目标是 es5 tsc [name].ts --strictNullChecks # 变量不可以赋值为 null undefined ``` 文档请看 `ts-axios-doc` 项目 ## 项目初始化 使用 [typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter) 项目进行初始化 ```bash git clone https://github.com/alexjoverm/typescript-library-starter ts-axios cd ts-axios npm install # npm install 之后，会自动执行一些操作，比如删除 .git，重命名等等 # 实现原理: package.json 中 scripts 增加了 postinstall 命令，该命令可以在 npm 装包后自动触发 # 官方链接: https://docs.npmjs.com/misc/scripts ``` ## 项目脚本 ```bash npm run dev # 启动 examples 中 express 服务及 webpack 打包服务 npm run build # 项目打包 npm run pub # 项目发布，版本升级，注意不要手动修改package.json的version，通过npm version会自动修改 # 注意package.json中以下几个字段 # "main": "dist/ts-axios.umd.js", umd 规范引入路径 # "module": "dist/ts-axios.es5.js", es 规范引入路径 # "typings": "dist/types/axios.d.ts", typescript类型定义文件位置 # "files": [ # "dist" # ], npm 发布的文件夹 ``` ## 代码提交 ```bash npm run commit git-cz # commitizen 包提供的 ``` ## tsconfig.json配置文件文档 - [tsconfi.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) - [compiler options](https://www.typescriptlang.org/docs/handbook/compiler-options.html) 以下为 TypeScript library starter 的文档 ## 参考文档汇总 - [url参数处理规范](https://en.wikipedia.org/wiki/Query_string#URL_encoding) - [XMLHttpRequest send方法](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/send) - [Mocking Axios in Jest + Testing Async Functions](https://www.youtube.com/watch?v=9Yrd4aZkse8) - [jest: Testing Asynchronous Code](https://jestjs.io/docs/en/asynchronous) - [UMD、CommonJS、ES Module、AMD、CMD模块的写法](https://www.4455q.com/tech/umd_commonjs_es-module_amd.html) ## 遗留问题 - test/helpers/error.spec.ts: super 继承对测试覆盖率支持的坑，暂时使用 /* istanbul ignore next */ 跳过了这里 ------ # TypeScript library starter [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Greenkeeper badge](https://badges.greenkeeper.io/alexjoverm/typescript-library-starter.svg)](https://greenkeeper.io/) [![Travis](https://img.shields.io/travis/alexjoverm/typescript-library-starter.svg)](https://travis-ci.org/alexjoverm/typescript-library-starter) [![Coveralls](https://img.shields.io/coveralls/alexjoverm/typescript-library-starter.svg)](https://coveralls.io/github/alexjoverm/typescript-library-starter) [![Dev Dependencies](https://david-dm.org/alexjoverm/typescript-library-starter/dev-status.svg)](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev) [![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://paypal.me/AJoverMorales) A starter project that makes creating a TypeScript library extremely easy. ![](https://i.imgur.com/opUmHp0.png) ### Usage ```bash git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME cd YOURFOLDERNAME # Run npm install and write your library name when asked. That's all! npm install ``` **Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name. ### Features - Zero-setup. After running `npm install` things will setup for you :wink: - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/) - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)** - **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency - **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)** - Automatic types `(*.d.ts)` file generation - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks) ### Importing library You can import the generated bundle to use the whole library generated by this starter: ```javascript import myLib from 'mylib' ``` Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library: ```javascript import something from 'mylib/dist/lib/something' ``` ### NPM scripts - `npm t`: Run test suite - `npm start`: Run `npm run build` in watch mode - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch) - `npm run test:prod`: Run linting and generate coverage - `npm run build`: Generate bundles and typings, create docs - `npm run lint`: Lints code - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:) ### Excluding peerDependencies On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that. Good news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`. ### Automatic releases _**Prerequisites**: you need to create/login accounts and add your project to:_ - [npm](https://www.npmjs.com/) - [Travis CI](https://travis-ci.org) - [Coveralls](https://coveralls.io) _**Prerequisite for Windows**: Semantic-release uses **[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to install [Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) using this command:_ ```bash npm install --global --production windows-build-tools ``` #### Setup steps Follow the console instructions to install semantic release and run it (answer NO to "Do you want a `.travis.yml` file with semantic-release setup?"). _Note: make sure you've setup `repository.url` in your `package.json` file_ ```bash npm install -g semantic-release-cli semantic-release-cli setup # IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P ``` From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits. Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) ### Git Hooks There is already set a `precommit` hook for formatting your code with Prettier :nail_care: By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure: - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog) - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push` This makes more sense in combination with [automatic releases](#automatic-releases) ### FAQ #### `Array.prototype.from`, `Promise`, `Map`... is undefined? TypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`). For a library, `core-js` plays very nicely, since you can import just the polyfills you need: ```javascript import "core-js/fn/array/find" import "core-js/fn/string/includes" import "core-js/fn/promise" ... ``` #### What is `npm install` doing on first run? It runs the script `tools/init` which sets up everything for you. In short, it: - Configures RollupJS for the build, which creates the bundles - Configures `package.json` (typings file, main file, etc) - Renames main src and test files #### What if I don't want git-hooks, automatic releases or semantic-release? Then you may want to: - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit - Remove `npm run semantic-release` from `.travis.yml` #### What if I don't want to use coveralls or report my coverage? Remove `npm run report-coverage` from `.travis.yml` ## Resources - [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) - [📺 Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) - [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed) ## Projects using `typescript-library-starter` Here are some projects that use `typescript-library-starter`: - [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel) - [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable) - [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager) ## Credits Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): | [
Ciro](https://www.linkedin.com/in/ciro-ivan-agulló-guarinos-42109376)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s "Code") [🔧](#tool-k1r0s "Tools") | [
Marius Schulz](https://blog.mariusschulz.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz "Documentation") | [
Alexander Odell](https://github.com/alextrastero)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero "Documentation") | [
Ryan Ham](https://github.com/superamadeus)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus "Code") | [
Chi](https://consiiii.me)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Code") [🔧](#tool-ChinW "Tools") [📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Documentation") | [
Matt Mazzola](https://github.com/mattmazzola)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola "Code") [🔧](#tool-mattmazzola "Tools") | [
Sergii Lischuk](http://leefrost.github.io)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost "Code") | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | [
Steve Lee](http;//opendirective.com)
[🔧](#tool-SteveALee "Tools") | [
Flavio Corpa](http://flaviocorpa.com)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel "Code") | [
Dom](https://github.com/foreggs)
[🔧](#tool-foreggs "Tools") | [
Alex Coles](http://alexbcoles.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc "Documentation") | [
David Khourshid](https://github.com/davidkpiano)
[🔧](#tool-davidkpiano "Tools") | [
Aarón García Hervás](https://aarongarciah.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah "Documentation") | [
Jonathan Hart](https://www.stuajnht.co.uk)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht "Code") | | [
Sanjiv Lobo](https://github.com/Xndr7)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 "Documentation") | [
Stefan Aleksovski](https://github.com/sAleksovski)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski "Code") | [
dev.peerapong](https://github.com/devpeerapong)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong "Code") | [
Aaron Groome](http://twitter.com/Racing5372)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 "Documentation") | [
Aaron Reisman](https://github.com/lifeiscontent)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent "Code") | [
kid-sk](https://github.com/kid-sk)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk "Documentation") | [
Andrea Gottardi](http://about.me/andreagot)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot "Documentation") | | [
Yogendra Sharma](http://TechiesEyes.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma "Documentation") | [
Rayan Salhab](http://linkedin.com/in/rayan-salhab/)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes "Code") | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! --- _Source: https://npm.io/package/ts-axios-demo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._