# ko-genius

> A library for getting resources and parsing them into an object graph, all using the Knockout API

Latest version **0.0.2** (published 2014-08-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install ko-genius
pnpm add ko-genius
yarn add ko-genius
bun add ko-genius
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2014-08-14 |
| First published | 2014-08-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Cameron Edwards |
| Maintainers | cameronprattedwards |
| Keywords | knockout, data, resource, object, graph |

## Links

- npm: https://www.npmjs.com/package/ko-genius
- Repository: https://github.com/cameronprattedwards/ko-genius
- Issues: https://github.com/cameronprattedwards/ko-genius/issues
- npm.io page: https://npm.io/package/ko-genius

## Recent versions

- 0.0.2 (latest) — 2014-08-14
- 0.0.1 — 2014-08-14

## README

KO-Genius
=========

Knockout makes it easy to bind view models to the DOM. But once you need to do extensive interaction with the server and pull down view models using AJAX, your work becomes tedious, complicated, and filled with boilerplate. KO-Genius helps circumvent all of that with callback-free view model definitions and instantiations. No mapping required. Automatic parsing. 

And, unlike KnockBack, KO-Genius integrates with Knockout at its deepest levels, meaning smaller
downloads and much greater efficiency. KO-Genius is just like [Genius] (http://geniusjs.com 'Genius'), 
but with a few useful additions that make working with KnockoutJS super easy.

To use KO-Genius, just include it on the page after Knockout. Then you're ready to start working.

Benefits
--------

For starters, any Genius resource property created using a `genius.types.*` method will be a Knockout observable. For example, consider the following model definition:

	var Zombie = genius.Resource.extend({
		name: genius.types.string(),
		id: genius.types.number(),
		age: genius.types.number(),
		url: "/zombies/:id"
	});

	var zombies = Zombie.$query();
	ko.applyBindings({ myZombies: zombies });

Now use the following markup:
	
	<img src="spinner.gif" data-bind="visible: myZombies.isLoading" />
	<div data-bind="foreach: myZombies">
		<p>
			Name: 
			<span data-bind="text: name"></span>, 
			ID: 
			<span data-bind="text: id"></span>, 
			Age: 
			<span data-bind="text: age"></span>
		</p>
	</div>

`zombies` will become an observable array, and Knockout will render a list of your zombies, all with their appropriate information. `name`, `id`, and `age` will all be knockout observables. What's more, Resource meta-properties, such as `isLoading`, `isDirty`, `isDeleted`, and `isNew` are all observable, so you're free to use them as you please in your Knockout bindings. In this example, the spinner will appear when the zombies request begins, and will disappear when the request returns.

Installation
------------

You can install using Bower with `bower install ko-genius` and using NPM with `npm install ko-genius`. You can also just download ko-genius.js and add it manually to your project.

Tests
-----

KO-Genius tests use Karma with Jasmine. To run the tests:

* `npm install -g karma`
* Inside the repository root: `karma start`

If you don't have Chrome installed, you can change the browser in [karma.conf.js on line 59](https://github.com/cameronprattedwards/ko-genius/blob/master/karma.conf.js#L59).

Contributing
------------

Contributions are welcome. I'm not actively developing this project (I've moved on to another one that's more generic, vanilla JS), but I'll definitely try to fix your issues and review/merge any pull requests. I'm using [GitHub flow](https://guides.github.com/introduction/flow/index.html), so you can PR directly into master.

I tell you this despite the danger of creating a crisis of choice: if you're using RequireJS, [KO-Data](https://github.com/cameronprattedwards/ko-data) might be a better option for you. The API is a lot more sensible, and it doesn't try to recreate the Dependency Injection wheel.

---
_Source: https://npm.io/package/ko-genius · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._