Giter Club home page Giter Club logo

atomic's Introduction

atomic.js Build Status

atomic is a 1KB standalone module for getting a supported XHR instance, making HTTP requests and handling success/error callbacks. atomic has a very clean and readable syntax using Object chaining, as well as automatic JSON parsing when JSON is returned. atomic works in IE6+, but uses native JSON parsing which works in IE8+, so -IE8 won't parse the response.

atomic.get()

Use atomic.get() to make a GET. Success and error callbacks will return the xhr.responseText and full xhr as arguments one and two.

atomic.get('/endpoint')
.success(function (data, xhr) {
  
})
.error(function (data, xhr) {
  
});

atomic.post()

Use atomic.post() to make a POST. Success and error callbacks will return the xhr.responseText and full xhr as arguments one and two.

atomic.post('/endpoint'[, data])
.success(function (data, xhr) {
  
})
.error(function (data, xhr) {
  
});

atomic.put()

Use atomic.put() to make a PUT. Success and error callbacks will return the xhr.responseText and full xhr as arguments one and two.

atomic.put('/endpoint'[, data])
.success(function (data, xhr) {
  
})
.error(function (data, xhr) {
  
});

atomic.delete()

Use atomic.delete() to make a DELETE. Success and error callbacks will return the xhr.responseText and full xhr as arguments one and two.

atomic.delete('/endpoint')
.success(function (data, xhr) {
  
})
.error(function (data, xhr) {
  
});

Installing with Bower

Use the repository hook:

bower install https://github.com/toddmotto/atomic.git

Manual installation

Ensure you're using the files from the dist directory (contains compiled production-ready code). Ensure you place the script before the closing </body> tag.

<body>
  <!-- html above -->
  <script src="dist/atomic.js"></script>
  <script>
  atomic.get('/endpoint')
  .success(function (data, xhr) {

  })
  .error(function (data, xhr) {

  });
  </script>
</body>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release history

  • 1.0.0
    • Initial release

atomic's People

Contributors

robatron avatar toddmotto avatar vzwick avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.