jamesplease / jamesplease/backbone-orbit

Determine API

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

What should the API be for this thing?

My initial thoughts are:
1. `memorySource` should be referred to as `store`, as it is the primary interface that every app should be using.
2. Return Backbone Models and Collections from `find` rather than raw JavaScript objects
3. Add a parser that will accept raw Backbone Models and Collections and be able to transform that back into the plain JS objects that Orbit expects (when modifying data, for instance)
4. Override Backbone methods
- `Model#get` should support finding related resources. I spoke with @bmac briefly about what this API should look like.
- `Backbone.sync` should be ignored. Instead, the individual 'higher-level' methods on Models/Collections should be overrode to use Orbit APIs
#

Todos:
- Investigate Ember Data & Ember-Orbit for inspiration

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by investigating Ember Data and Ember-Orbit as listed, then compare the proposed store, find, parser, Model#get, and Backbone.sync directions. Done requires a decided API for the Backbone/Orbit integration; the issue does not name files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.