From ab208b13243edf2869247e0bbd6d9ee066799e01 Mon Sep 17 00:00:00 2001 From: Valeri Karpov Date: Mon, 4 Feb 2019 18:17:25 -0500 Subject: [PATCH] docs: hook up navbar search --- docs/advanced_schemas.html | 4 ++-- docs/api.html | 4 ++-- docs/browser.html | 4 ++-- docs/compatibility.html | 4 ++-- docs/connections.html | 4 ++-- docs/contributing.html | 4 ++-- docs/customschematypes.html | 4 ++-- docs/defaults.html | 4 ++-- docs/deprecations.html | 4 ++-- docs/discriminators.html | 4 ++-- docs/documents.html | 4 ++-- docs/faq.html | 4 ++-- docs/further_reading.html | 4 ++-- docs/geojson.html | 4 ++-- docs/guide.html | 4 ++-- docs/guides.html | 4 ++-- docs/index.html | 4 ++-- docs/jest.html | 4 ++-- docs/js/navbar-search.js | 11 +++++++++++ docs/lambda.html | 4 ++-- docs/layout.jade | 5 +++-- docs/middleware.html | 4 ++-- docs/migrating_to_5.html | 4 ++-- docs/migration.html | 4 ++-- docs/models.html | 4 ++-- docs/plugins.html | 4 ++-- docs/populate.html | 4 ++-- docs/prior.html | 4 ++-- docs/promises.html | 4 ++-- docs/queries.html | 4 ++-- docs/schematypes.html | 4 ++-- docs/subdocs.html | 4 ++-- docs/transactions.html | 4 ++-- docs/validation.html | 4 ++-- 34 files changed, 78 insertions(+), 66 deletions(-) create mode 100644 docs/js/navbar-search.js diff --git a/docs/advanced_schemas.html b/docs/advanced_schemas.html index a68cd35930f..3069abadc93 100644 --- a/docs/advanced_schemas.html +++ b/docs/advanced_schemas.html @@ -1,4 +1,4 @@ -Mongoose v5.4.10-pre: Advanced Schemas

Creating from ES6 Classes Using loadClass()

Mongoose allows creating schemas from ES6 classes. +Mongoose v5.4.10-pre: Advanced Schemas

Creating from ES6 Classes Using loadClass()

Mongoose allows creating schemas from ES6 classes. The loadClass() function lets you pull in methods, statics, and virtuals from an ES6 class. A class method maps to a schema method, a static method maps to a schema static, and getters/setters map @@ -63,7 +63,7 @@ pathname: window.location.pathname, hash: window.location.hash }); -});

API Docs

+Mongoose v5.4.10-pre: API docs

API Docs

Index

Mongoose()

Mongoose constructor.

@@ -4672,7 +4672,7 @@

Note:

pathname: window.location.pathname, hash: window.location.hash }); -});

Mongoose in the Browser

+Mongoose v5.4.10-pre: Browser Library

Mongoose in the Browser

Mongoose supports creating schemas and validating documents in the browser. Mongoose's browser library does not support saving documents, queries, @@ -94,7 +94,7 @@

Building With Webpack

pathname: window.location.pathname, hash: window.location.hash }); -});

MongoDB Server Version Compatibility

+Mongoose v5.4.10-pre: MongoDB Version Compatibility

MongoDB Server Version Compatibility

Connections

+Mongoose v5.4.10-pre: Connecting to MongoDB

Connections

Contributing

+Mongoose v5.4.10-pre: Contributing

Contributing

Please read all about contributing here.

Creating a Basic Custom Schema Type

New in Mongoose 4.4.0: Mongoose supports custom types. Before you +Mongoose v5.4.10-pre: Custom Schema Types

Creating a Basic Custom Schema Type

New in Mongoose 4.4.0: Mongoose supports custom types. Before you reach for a custom type, however, know that a custom type is overkill for most use cases. You can do most basic tasks with custom getters/setters, @@ -61,7 +61,7 @@ pathname: window.location.pathname, hash: window.location.hash }); -});

Declaring defaults in your schema

Your schemas can define default values for certain paths. If you create +Mongoose v5.4.10-pre: Defaults

Declaring defaults in your schema

Your schemas can define default values for certain paths. If you create a new document without that path set, the default will kick in.

Note: Mongoose only applies a default if the value of the path is strictly undefined.

@@ -133,7 +133,7 @@

Defaul pathname: window.location.pathname, hash: window.location.hash }); -});

Deprecation Warnings

+Mongoose v5.4.10-pre: Deprecation Warnings

Deprecation Warnings

The model.discriminator() function

Discriminators are a schema inheritance mechanism. They enable +Mongoose v5.4.10-pre: Discriminators

The model.discriminator() function

Discriminators are a schema inheritance mechanism. They enable you to have multiple models with overlapping schemas on top of the same underlying MongoDB collection.

Suppose you wanted to track different types of events in a single @@ -322,7 +322,7 @@

(function (window, document) { +});

Documents

+Mongoose v5.4.10-pre: Documents

Documents

FAQ

+

FAQ

Further Reading

+

Further Reading

Using GeoJSON

+Mongoose v5.4.10-pre: Using GeoJSON

Using GeoJSON

GeoJSON is a format for storing geographic points and polygons. MongoDB has excellent support for geospatial queries on GeoJSON objects. Let's take a look at how you can use Mongoose to store @@ -145,7 +145,7 @@

Geospatial Queries with Mongoose

pathname: window.location.pathname, hash: window.location.hash }); -});

Schemas

+Mongoose v5.4.10-pre: Schemas

Schemas

Guides

+Mongoose v5.4.10-pre: Schemas

Guides

Mongoose guides provide detailed tutorials on Mongoose's core concepts and integrating Mongoose with external tools and frameworks.

Mongoose Core Concepts

@@ -47,7 +47,7 @@

Migration Guides

pathname: window.location.pathname, hash: window.location.hash }); -});

Getting Started

+

Getting Started

First be sure you have MongoDB and Node.js installed.

Next install Mongoose from the command line using npm:

$ npm install mongoose
@@ -100,7 +100,7 @@ 
Congratulations

     pathname: window.location.pathname,
     hash: window.location.hash
   });
-});
Testing Mongoose with Jest

+Mongoose v5.4.10-pre: Testing Mongoose with Jest
Testing Mongoose with Jest

 
Jest is a client-side JavaScript testing library developed by Facebook.
 It was one of the libraries affected by Facebook's licensing scandal in 2017.
 Because Jest is designed primarily for testing React applications, using
@@ -68,7 +68,7 @@ 
Further Reading

     pathname: window.location.pathname,
     hash: window.location.hash
   });
-});
Using Mongoose With AWS Lambda
AWS Lambda is a popular service for running
+Mongoose v5.4.10-pre: Using Mongoose With AWS Lambda
Using Mongoose With AWS Lambda
AWS Lambda is a popular service for running
 arbitrary functions without managing individual servers. Using Mongoose in your
 AWS Lambda functions is easy. Here's a sample function that connects to a
 MongoDB instance and finds a single document:

@@ -76,7 +76,7 @@
     pathname: window.location.pathname,
     hash: window.location.hash
   });
-});
         .container
@@ -119,6 +119,7 @@ html(lang='en')
             block content
         include includes/keen
 
+        script(type="text/javascript" src="/docs/js/navbar-search.js")
         script(type="text/javascript").
           (function (window, document) {
             var layout   = document.getElementById('layout'),
diff --git a/docs/middleware.html b/docs/middleware.html
index 7d4eb8a7b1c..87a808970b5 100644
--- a/docs/middleware.html
+++ b/docs/middleware.html
@@ -1,4 +1,4 @@
-Mongoose v5.4.10-pre: Middleware
Middleware

+Mongoose v5.4.10-pre: Middleware
Middleware

 
Migrating from 4.x to 5.x

+
Migrating from 4.x to 5.x

 
Migrating from 3.x to 4.x
There are several backwards-breaking changes to be aware of when migrating from Mongoose 3 to Mongoose 4.

+
Migrating from 3.x to 4.x
There are several backwards-breaking changes to be aware of when migrating from Mongoose 3 to Mongoose 4.

 
findOneAndUpdate() new field is now false by default

 
 
Mongoose's findOneAndUpdate(), findOneAndRemove(),
@@ -49,7 +49,7 @@ 
More Info

     pathname: window.location.pathname,
     hash: window.location.hash
   });
-});
Models

+Mongoose v5.4.10-pre: Models
Models

 
Plugins

+Mongoose v5.4.10-pre: Plugins
Plugins

 
Populate

+Mongoose v5.4.10-pre: Query Population
Populate

 
Prior Release Documentation
Prior Release Documentation
Built-in Promises
Mongoose async operations, like .save() and queries, return thenables.
+Mongoose v5.4.10-pre: Promises
Built-in Promises
Mongoose async operations, like .save() and queries, return thenables.
 This means that you can do things like MyModel.findOne({}).then() and
 await MyModel.findOne({}).exec() if you're using
 async/await.

@@ -84,7 +84,7 @@ 
(function (window, document) {
+});
Queries

+Mongoose v5.4.10-pre: Queries
Queries

 
SchemaTypes

+Mongoose v5.4.10-pre: SchemaTypes
SchemaTypes

 
 
Subdocuments

+Mongoose v5.4.10-pre: SubDocuments
Subdocuments

 
Transactions in Mongoose

+Mongoose v5.4.10-pre: Transactions
Transactions in Mongoose

 
Transactions are new in MongoDB
 4.0 and Mongoose 5.2.0. Transactions let you execute multiple operations
 in isolation and potentially undo all the operations if one of them fails.
@@ -157,7 +157,7 @@ 
With the Aggregation Framework

     pathname: window.location.pathname,
     hash: window.location.hash
   });
-});
Validation
Before we get into the specifics of validation syntax, please keep the following rules in mind:

+Mongoose v5.4.10-pre: Validation