[
{
"id": "ember-cli-mirage/db-collection",
"file": "ember-cli-mirage/db-collection",
"functions": [],
"variables": [],
"classes": [
{
"id": "ember-cli-mirage/db-collection~DbCollection",
"name": "DbCollection",
"file": "ember-cli-mirage/db-collection",
"exportType": "default",
"description": "The collection attached to the database object.
\n
For example if you had the following data file named mirage/fixtures/contacts.js
\n
export default [\n {id: 1, name: 'Zelda'},\n {id: 2, name: 'Link'}\n];
then db.contacts would return this array.
Returns a copy of the data, to prevent inadvertent data manipulation.
Inserts data into the collection. data can be a single object\nor an array of objects. Returns the inserted record.
\n
\nlet link = db.users.insert({name: 'Link', age: 173});\n\nlink; \n\n\nlet users = db.users.insert([\n {name: 'Zelda', age: 142},\n {name: 'Epona', age: 58},\n]);\n\nusers;
Returns a single record from the collection if ids is a single\nid, or an array of records if ids is an array of ids. Note\neach id can be an int or a string, but integer ids as strings\n(e.g. the string “1”) will be treated as integers.
Returns the first model from collection that matches the\nkey-value pairs in the query object. Note that a string\ncomparison is used. query is a POJO.
Returns an array of models from collection that match the\nkey-value pairs in the query object. Note that a string\ncomparison is used. query is a POJO.
Finds the first record matching the provided query in\ncollection, or creates a new record using a merge of the\nquery and optional attributesForCreate.
Updates one or more records in collection.\nIf attrs is the only arg present, updates all records\nin the collection according to the key-value pairs in attrs.\nIf target is present, restricts updates to those that\nmatch target. If target is a number or string, finds a\nsingle record whose id is target to update. If target is\na POJO, queries collection for records that match the\nkey-value pairs in target, and updates their attrs.\nReturns the updated record or records.
Removes one or more records in collection.\nIf target is undefined, removes all records.\nIf target is a number or string, removes a\nsingle record using target as id. If target is\na POJO, queries collection for records that\nmatch the key-value pairs in target, and\nremoves them from the collection.
Get all ember data models under the app's namespaces
Get all mirage models for each of the ember-data models
A lookup method for an autogenerated model
IdentityManager for a DbCollection
A setter for schema, since we don't have a reference at constuction time.
Returns true if the association is reflexive.
The belongsTo association adds a fk to the owner of the association
Registers belongs-to association defined by given key on given model,\ndefines getters / setters for associated parent and associated parent's id,\nadds methods for creating unsaved parent record and creating a saved one
Registers has-many association defined by given key on given model,\ndefines getters / setters for associated records and associated records' ids,\nadds methods for creating unsaved child records and creating saved ones
Collections represent arrays of models. They are returned by a hasMany association, or by one of the ModelClass query methods:
\n
let posts = user.blogPosts;\nlet posts = schema.blogPosts.all();\nlet posts = schema.blogPosts.find([1, 2, 4]);\nlet posts = schema.blogPosts.where({ published: true });
Updates each model in the collection, and immediately persists all changes to the db.
\n
let posts = author.blogPosts.all();\n\nposts.update('published', true);
Destroys the db record for all models in the collection.
\n
let posts = author.blogPosts.all();\n\nposts.destroy();
Saves all models in the collection.
\n
let posts = author.blogPosts.all();\n\nposts.models[0].published = true;\n\nposts.save();
Reloads each model in the collection.
Adds a model to this collection.
\n
user.posts.add(newPost);
Removes a model to this collection
Checks if the collection includes the model
Returns a new Collection with its models sorted according to the provided compare function.
\n
let posts = author.blogPosts.all();\n\nlet postsByTitleAsc = posts.sort((a, b) => {\n return b.title < a.title;\n});
Simple string representation of the collection and id.
The number of models in the collection.
\n
user.posts.length;
Creates or saves the model.
Update the record in the db.
Boolean, true if the model has not been persisted yet to the db.
\n
Originally this method simply checked if the model had an id; however,\nwe let people create models with pre-specified ids. So, we have to\ncheck whether the record is in the actual databse or not.
Boolean, opposite of isNew
Reload a model’s data from the database.
Returns the association for the given key
Returns this model's inverse association for the given\nmodel-type-association pair, if it exists.
\n
Example:
\n
post: Model.extend({\n comments: hasMany()\n}),\ncomments: Model.extend({\n post: belongsTo()\n})
post.inversefor(commentsPostAssociation) would return the\npost.comments association object.
\n
Originally we had association.inverse() but that became impossible with\nthe addition of polymorphic models. Consider the following:
\n
post: Model.extend({\n comments: hasMany()\n}),\npicture: Model.extend({\n comments: hasMany()\n}),\ncomments: Model.extend({\n commentable: belongsTo({ polymorphic: true })\n})
commentable.inverse() is ambiguous - does it return\npost.comments or picture.comments? Instead we need to ask each model\nif it has an inverse for a given association. post.inverseFor(commentable)\nis no longer ambiguous.
Finds the inverse for an association that explicity defines it's inverse
Ensures multiple explicit inverses don't exist on the current model\nfor the given association.
\n
TODO: move this to compile-time check
Finds if there is an inverse for an association that does not\nexplicitly define one.
Returns whether this model has an inverse association for the given\nmodel-type-association pair.
Used to check if models match each other. If models are saved, we check model type\nand id, since they could have other non-persisted properties that are different.
model.attrs represents the persistable attributes, i.e. your db\ntable fields.
Define getter/setter for a plain attribute
Foreign keys get set on attrs directly (to avoid potential recursion), but\nmodel references use the setter.
\n
We validate foreign keys during instantiation.
Originally we validated this via association.setId method, but it triggered\nrecursion. That method is designed for updating an existing model's ID so\nthis method is needed during instantiation.
Update associated children when saving a collection
Simple string representation of the model and id.
Checks the equality of this model and the passed-in model
An array of models, returned from one of the schema query\nmethods (all, find, where). Knows how to update and destroy its models.
\n
Identical to Collection except it can contain a heterogeneous array of\nmodels. Thus, it has no modelName property. This lets serializers and\nother parts of the system interact with it differently.
Updates each model in the collection (persisting immediately to the db).
Destroys the db record for all models in the collection.
Saves all models in the collection.
Reloads each model in the collection.
Adds a model to this collection
Removes a model to this collection
Checks if the collection includes the model
Simple string representation of the collection and id.
Number of models in the collection.
Takes a record and returns a model, or an array of records\nand returns a collection.
Override this method to implement your own custom\nserialize function. primaryResource is whatever was returned\nfrom your route handler, and request is the Pretender\nrequest object. Returns a plain JavaScript object or\narray, which Mirage uses as the response data to your\nEmber app’s XHR request. You can also override this method,\ncall super, and manipulate the data before Mirage responds\nwith it. This is a great place to add metadata, or for\none-off operations that don’t fit neatly into any of\nMirage’s other abstractions.
Used to define a custom key when serializing a\nprimary model of modelName modelName.
Used to customize the key when serializing a primary\ncollection. By default this pluralizes the return\nvalue of keyForModel.
Used to customize how a model’s attribute is\nformatted in your JSON payload.
Use this hook to format the key for collections\nrelated to this model.
\n
For example, if you're serializing an author that\nside loads many blogPosts, you would get blogPost\nas an argument, and whatever you return would\nend up as the collection key in your JSON:
\n
keyForRelationship(type) {\n return dasherize(type);\n}
\n
{\n author: {...},\n 'blog-posts': [...]\n}
Use this hook to format the key for relationship ids\nin this model's JSON representation.
\n
For example, if you're serializing an author that\nside loads many blogPosts, you would get blogPost\nas an argument, and whatever you return would\nend up as part of the author JSON:
\n
keyForRelationshipIds(type) {\n return dasherize(type) + '-ids';\n}
\n
{\n author: {\n ...,\n 'blog-post-ids': [1, 2, 3]\n },\n 'blog-posts': [...]\n}
This method is used by the POST and PUT shorthands. These shorthands\nexpect a valid JSON:API document as part of the request, so that\nthey know how to create or update the appropriate resouce. The normalize\nmethod allows you to transform your request body into a JSON:API\ndocument, which lets you take advantage of the shorthands when you\notherwise may not be able to.
\n
Note that this method is a noop if you’re using JSON:API already,\nsince request payloads sent along with POST and PUT requests will\nalready be in the correct format.
The Mirage server.
\n
Note that this within your config function in mirage/config.js refers to the server instance, which is the same instance that server refers to in your tests.
Set the base namespace used for all routes defined with get, post, put or del.
\n
For example,
\n
\nexport default function() {\n\n this.namespace = '/api';\n\n \n this.get('/contacts', 'contacts');\n};
\n
Note that only routes defined after this.namespace are affected. This is useful if you have a few one-off routes that you don't want under your namespace:
\n
\nexport default function() {\n\n \n this.get('/auth', function() { ...});\n\n this.namespace = '/api';\n \n this.get('/contacts', 'contacts');\n};
\n
If your Ember app is loaded from the filesystem vs. a server (e.g. via Cordova or Electron vs. ember s or https://yourhost.com/), you will need to explicitly define a namespace. Likely values are / (if requests are made with relative paths) or https://yourhost.com/api/... (if requests are made to a defined server).
\n
For a sample implementation leveraging a configured API host & namespace, check out this issue comment
Determines if the current environment is the testing environment.
Determines if the server should log.
Determines if the server should track requests.
Load the configuration given, setting timing to 0 if in the test\nenvironment.
Whitelist requests to the specified paths and allow them to pass through\nyour Mirage server to the actual network layer.
Load the all or only the specified fixtures into Mirage's database.
Load factories into Mirage's database.
Get the factory for a given type.
Builds a full path for Pretender to monitor based on the path and\nconfigured options (urlPrefix and namespace).