mirror of
https://code.equilibrium.co.ao/ITO/doneit-web.git
synced 2026-04-20 21:35:50 +00:00
merge chat
This commit is contained in:
Peter Maquiran
@@ -1,46 +0,0 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at code@dexie.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
@@ -1,65 +0,0 @@
|
||||
HOW TO CONTRIBUTE
|
||||
=================
|
||||
|
||||
We appreciate contributions in forms of:
|
||||
|
||||
* issues
|
||||
* help answering questions in [issues](https://github.com/dexie/Dexie.js/issues) and on [stackoverflow](https://stackexchange.com/filters/233583/dexie-stackoverflow)
|
||||
* fixing bugs via pull-requests
|
||||
* developing addons or other [derived work](https://dexie.org/docs/DerivedWork)
|
||||
* promoting Dexie.js
|
||||
* sharing ideas
|
||||
|
||||
Contribute while developing your own app
|
||||
========================================
|
||||
|
||||
Dexie uses pnpm package manager. Refer to [pnpm.io/installation](https://pnpm.io/installation) for how to install pnpm.
|
||||
|
||||
Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie` for the app your are developing.
|
||||
|
||||
1. Fork Dexie.js from the web gui on github
|
||||
2. Clone your fork locally by launching a shell/command window and cd to a neutral place (like `~repos/`, `c:\repos` or whatever)
|
||||
3. Run the following commands:
|
||||
|
||||
```
|
||||
git clone https://github.com/YOUR-USERNAME/Dexie.js.git dexie
|
||||
cd dexie
|
||||
pnpm install
|
||||
pnpm run build
|
||||
npm link # Or yarn link or pnpm link --global depending on what package manager you are using.
|
||||
```
|
||||
3. cd to your app directory and write:
|
||||
```
|
||||
npm link dexie # Or yarn link dexie / pnpm link dexie depending on your package manager.
|
||||
```
|
||||
|
||||
Your app's `node_modules/dexie/` is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using `pnpm run build` or `pnpm run watch`. The latter will react on any source file change and rebuild the dist files.
|
||||
|
||||
That's it. Now you're up and running to test and commit changes to files under dexie/src/* or dexie/test/* and the changes will instantly affect the app you are developing.
|
||||
|
||||
If you're on yarn or pnpm, do the same procedures using yarn link / pnpm link.
|
||||
|
||||
Pull requests are more than welcome. Some advices are:
|
||||
|
||||
* Run pnpm test before making a pull request.
|
||||
* If you find an issue, a unit test that reproduces it is lovely ;). If you don't know where to put it, put it in `test/tests-misc.js`. We use qunit. Just look at existing tests in `tests-misc.js` to see how they should be written. Tests are transpiled in the build script so you can use ES6 if you like.
|
||||
|
||||
Build
|
||||
-----
|
||||
```
|
||||
# To install pnpm, see https://pnpm.io/installation
|
||||
pnpm install
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
Test
|
||||
----
|
||||
```
|
||||
pnpm test
|
||||
```
|
||||
|
||||
Watch
|
||||
-----
|
||||
```
|
||||
pnpm run watch
|
||||
```
|
||||
@@ -1,202 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
Dexie.js
|
||||
|
||||
Copyright (c) 2014-2017 David Fahlander
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -1,292 +0,0 @@
|
||||
# Dexie.js
|
||||
|
||||
[![NPM Version][npm-image]][npm-url] 
|
||||
|
||||
Dexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org.
|
||||
|
||||
#### Why Dexie.js?
|
||||
|
||||
IndexedDB is the portable database for all browser engines. Dexie.js makes it fun and easy to work with.
|
||||
|
||||
But also:
|
||||
|
||||
* Dexie.js is widely used by 100,000 of web sites, apps and other projects and supports all browsers, Electron for Desktop apps, Capacitor for iOS / Android apps and of course pure PWAs.
|
||||
* Dexie.js works around bugs in the IndexedDB implementations, giving a more stable user experience.
|
||||
* It's an easy step to [make it sync](https://dexie.org/#sync).
|
||||
|
||||
#### Hello World
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<script src="https://unpkg.com/dexie/dist/dexie.js"></script>
|
||||
<script>
|
||||
|
||||
//
|
||||
// Declare Database
|
||||
//
|
||||
const db = new Dexie('FriendDatabase');
|
||||
db.version(1).stores({
|
||||
friends: '++id, age'
|
||||
});
|
||||
|
||||
//
|
||||
// Play with it
|
||||
//
|
||||
db.friends.add({ name: 'Alice', age: 21 }).then(() => {
|
||||
return db.friends
|
||||
.where('age')
|
||||
.below(30)
|
||||
.toArray();
|
||||
}).then(youngFriends => {
|
||||
alert (`My young friends: ${JSON.stringify(youngFriends)}`);
|
||||
}).catch (e => {
|
||||
alert(`Oops: ${e}`);
|
||||
});
|
||||
|
||||
</script>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
Yes, it's that simple. Read [the docs](https://dexie.org/docs/) to get into the details.
|
||||
|
||||
#### Hello World (for modern browsers)
|
||||
|
||||
All modern browsers support ES modules and top-level awaits. No transipler needed. Here's the previous example in a modern flavour:
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<script type="module">
|
||||
// Import Dexie
|
||||
import { Dexie } from 'https://unpkg.com/dexie/dist/modern/dexie.mjs';
|
||||
|
||||
//
|
||||
// Declare Database
|
||||
//
|
||||
const db = new Dexie('FriendDatabase');
|
||||
db.version(1).stores({
|
||||
friends: '++id, age'
|
||||
});
|
||||
|
||||
//
|
||||
// Play with it
|
||||
//
|
||||
try {
|
||||
await db.friends.add({ name: 'Alice', age: 21 });
|
||||
|
||||
const youngFriends = await db.friends
|
||||
.where('age')
|
||||
.below(30)
|
||||
.toArray();
|
||||
|
||||
alert(`My young friends: ${JSON.stringify(youngFriends)}`);
|
||||
} catch (e) {
|
||||
alert(`Oops: ${e}`);
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
#### Hello World (React + Typescript)
|
||||
|
||||
Real-world apps are often built using components in various frameworks. Here's a version of Hello World written for React and Typescript. There are also links below this sample to more tutorials for different frameworks...
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { Dexie, type EntityTable } from 'dexie';
|
||||
import { useLiveQuery } from 'dexie-react-hooks';
|
||||
|
||||
// Typing for your entities (hint is to move this to its own module)
|
||||
export interface Friend {
|
||||
id: number;
|
||||
name: string;
|
||||
age: number;
|
||||
}
|
||||
|
||||
// Database declaration (move this to its own module also)
|
||||
export const db = new Dexie('FriendDatabase') as Dexie & {
|
||||
friends: EntityTable<Friend, 'id'>;
|
||||
};
|
||||
db.version(1).stores({
|
||||
friends: '++id, age',
|
||||
});
|
||||
|
||||
// Component:
|
||||
export function MyDexieReactComponent() {
|
||||
const youngFriends = useLiveQuery(() =>
|
||||
db.friends
|
||||
.where('age')
|
||||
.below(30)
|
||||
.toArray()
|
||||
);
|
||||
|
||||
return (
|
||||
<>
|
||||
<h3>My young friends</h3>
|
||||
<ul>
|
||||
{youngFriends?.map((f) => (
|
||||
<li key={f.id}>
|
||||
Name: {f.name}, Age: {f.age}
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
<button
|
||||
onClick={() => {
|
||||
db.friends.add({ name: 'Alice', age: 21 });
|
||||
}}
|
||||
>
|
||||
Add another friend
|
||||
</button>
|
||||
</>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
[Tutorials for React, Svelte, Vue, Angular and vanilla JS](https://dexie.org/docs/Tutorial/Getting-started)
|
||||
|
||||
[API Reference](https://dexie.org/docs/API-Reference)
|
||||
|
||||
[Samples](https://dexie.org/docs/Samples)
|
||||
|
||||
### Performance
|
||||
|
||||
Dexie has kick-ass performance. Its [bulk methods](<https://dexie.org/docs/Table/Table.bulkPut()>) take advantage of a lesser-known feature in IndexedDB that makes it possible to store stuff without listening to every onsuccess event. This speeds up the performance to a maximum.
|
||||
|
||||
#### Supported operations
|
||||
|
||||
```js
|
||||
above(key): Collection;
|
||||
aboveOrEqual(key): Collection;
|
||||
add(item, key?): Promise;
|
||||
and(filter: (x) => boolean): Collection;
|
||||
anyOf(keys[]): Collection;
|
||||
anyOfIgnoreCase(keys: string[]): Collection;
|
||||
below(key): Collection;
|
||||
belowOrEqual(key): Collection;
|
||||
between(lower, upper, includeLower?, includeUpper?): Collection;
|
||||
bulkAdd(items: Array): Promise;
|
||||
bulkDelete(keys: Array): Promise;
|
||||
bulkPut(items: Array): Promise;
|
||||
clear(): Promise;
|
||||
count(): Promise;
|
||||
delete(key): Promise;
|
||||
distinct(): Collection;
|
||||
each(callback: (obj) => any): Promise;
|
||||
eachKey(callback: (key) => any): Promise;
|
||||
eachPrimaryKey(callback: (key) => any): Promise;
|
||||
eachUniqueKey(callback: (key) => any): Promise;
|
||||
equals(key): Collection;
|
||||
equalsIgnoreCase(key): Collection;
|
||||
filter(fn: (obj) => boolean): Collection;
|
||||
first(): Promise;
|
||||
get(key): Promise;
|
||||
inAnyRange(ranges): Collection;
|
||||
keys(): Promise;
|
||||
last(): Promise;
|
||||
limit(n: number): Collection;
|
||||
modify(changeCallback: (obj: T, ctx:{value: T}) => void): Promise;
|
||||
modify(changes: { [keyPath: string]: any } ): Promise;
|
||||
noneOf(keys: Array): Collection;
|
||||
notEqual(key): Collection;
|
||||
offset(n: number): Collection;
|
||||
or(indexOrPrimayKey: string): WhereClause;
|
||||
orderBy(index: string): Collection;
|
||||
primaryKeys(): Promise;
|
||||
put(item: T, key?: Key): Promise;
|
||||
reverse(): Collection;
|
||||
sortBy(keyPath: string): Promise;
|
||||
startsWith(key: string): Collection;
|
||||
startsWithAnyOf(prefixes: string[]): Collection;
|
||||
startsWithAnyOfIgnoreCase(prefixes: string[]): Collection;
|
||||
startsWithIgnoreCase(key: string): Collection;
|
||||
toArray(): Promise;
|
||||
toCollection(): Collection;
|
||||
uniqueKeys(): Promise;
|
||||
until(filter: (value) => boolean, includeStopEntry?: boolean): Collection;
|
||||
update(key: Key, changes: { [keyPath: string]: any }): Promise;
|
||||
```
|
||||
|
||||
This is a mix of methods from [WhereClause](https://dexie.org/docs/WhereClause/WhereClause), [Table](https://dexie.org/docs/Table/Table) and [Collection](https://dexie.org/docs/Collection/Collection). Dive into the [API reference](https://dexie.org/docs/API-Reference) to see the details.
|
||||
|
||||
## Dexie Cloud
|
||||
|
||||
[Dexie Cloud](https://dexie.org/cloud/) is a commercial offering that can be used as an add-on to Dexie.js. It syncs a Dexie database with a server and enables developers to build apps without having to care about backend or database layer else than the frontend code with Dexie.js as the sole database layer.
|
||||
|
||||
Source for a sample Dexie Cloud app: [Dexie Cloud To-do app](https://github.com/dexie/Dexie.js/tree/master/samples/dexie-cloud-todo-app)
|
||||
|
||||
See the sample Dexie Cloud app in action: https://dexie.github.io/Dexie.js/dexie-cloud-todo-app/
|
||||
|
||||
## Samples
|
||||
|
||||
https://dexie.org/docs/Samples
|
||||
|
||||
https://github.com/dexie/Dexie.js/tree/master/samples
|
||||
|
||||
## Knowledge Base
|
||||
|
||||
[https://dexie.org/docs/Questions-and-Answers](https://dexie.org/docs/Questions-and-Answers)
|
||||
|
||||
## Website
|
||||
|
||||
[https://dexie.org](https://dexie.org)
|
||||
|
||||
## Install via npm
|
||||
|
||||
```
|
||||
npm install dexie
|
||||
```
|
||||
|
||||
## Download
|
||||
|
||||
For those who don't like package managers, here's the download links:
|
||||
|
||||
### UMD (for legacy script includes as well as commonjs require):
|
||||
|
||||
https://unpkg.com/dexie@latest/dist/dexie.min.js
|
||||
|
||||
https://unpkg.com/dexie@latest/dist/dexie.min.js.map
|
||||
|
||||
### Modern (ES module):
|
||||
|
||||
https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs
|
||||
|
||||
https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs.map
|
||||
|
||||
### Typings:
|
||||
|
||||
https://unpkg.com/dexie@latest/dist/dexie.d.ts
|
||||
|
||||
# Contributing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
## Build
|
||||
|
||||
```
|
||||
pnpm install
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
## Test
|
||||
|
||||
```
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## Watch
|
||||
|
||||
```
|
||||
pnpm run watch
|
||||
```
|
||||
|
||||
<br/>
|
||||
|
||||
[](https://www.lambdatest.com/)
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/dexie.svg?style=flat
|
||||
[npm-url]: https://npmjs.org/package/dexie
|
||||
@@ -1,26 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
| Version | Supported | Branch
|
||||
| ------- | ------------------ | --------
|
||||
| 4.x | :white_check_mark: | master
|
||||
| 3.x | :white_check_mark: | master-3
|
||||
| 2.0.x | :x: | master-2
|
||||
| 1.5.x | :x: | master-1
|
||||
| < 1.5.1 | :x: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
To report a security vulnerability in Dexie.js, please send an email to code@dexie.org describing the vulnerability and how to reproduce it.
|
||||
|
||||
If we find an issue to be regarded as a security vulnerability, we will patch and release a new version in all the supported versions as soon as possible.
|
||||
Keep in mind though that this is an uncommercial open source project which means that sometimes you might have to be the one that
|
||||
*fixes* the issue and not just report it.
|
||||
|
||||
## Fixing a Vulnerability
|
||||
|
||||
Fix the issue in the corresponding branch for the major version according to the table above where it applies and
|
||||
create pull requests. Make sure that you have the words "security" or "vulnerability" in the title of the Pull Request
|
||||
in order to get the correct attention for it to be merged and released as soon as possible.
|
||||
|
||||
Vendored
-1174
File diff suppressed because it is too large
Load Diff
Vendored
-5898
File diff suppressed because it is too large
Load Diff
Vendored
-1
File diff suppressed because one or more lines are too long
Vendored
-2
File diff suppressed because one or more lines are too long
-1
File diff suppressed because one or more lines are too long
Vendored
-5871
File diff suppressed because it is too large
Load Diff
Vendored
-1
File diff suppressed because one or more lines are too long
-2
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
-5768
File diff suppressed because it is too large
Load Diff
-1
File diff suppressed because one or more lines are too long
@@ -1,2 +0,0 @@
|
||||
export * from './dist/dexie.js';
|
||||
export { default } from './dist/dexie.js';
|
||||
@@ -1,15 +0,0 @@
|
||||
// Making the module version consumable via require - to prohibit
|
||||
// multiple occurrancies of the same module in the same app
|
||||
// (dual package hazard, https://nodejs.org/api/packages.html#dual-package-hazard)
|
||||
import _Dexie from "./dist/dexie.min.js";
|
||||
const DexieSymbol = Symbol.for("Dexie");
|
||||
const Dexie = globalThis[DexieSymbol] || (globalThis[DexieSymbol] = _Dexie);
|
||||
if (_Dexie.semVer !== Dexie.semVer) {
|
||||
throw new Error(`Two different versions of Dexie loaded in the same app: ${_Dexie.semVer} and ${Dexie.semVer}`);
|
||||
}
|
||||
const {
|
||||
liveQuery, mergeRanges, rangesOverlap, RangeSet, cmp, Entity,
|
||||
PropModSymbol, PropModification, replacePrefix, add, remove } = Dexie;
|
||||
export { liveQuery, mergeRanges, rangesOverlap, RangeSet, cmp, Dexie, Entity,
|
||||
PropModSymbol, PropModification, replacePrefix, add, remove };
|
||||
export default Dexie;
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './dist/dexie.js';
|
||||
export { default } from './dist/dexie.js';
|
||||
@@ -1,14 +0,0 @@
|
||||
// Making the module version consumable via require - to prohibit
|
||||
// multiple occurrancies of the same module in the same app
|
||||
// (dual package hazard, https://nodejs.org/api/packages.html#dual-package-hazard)
|
||||
import _Dexie from "./dist/dexie.js";
|
||||
const DexieSymbol = Symbol.for("Dexie");
|
||||
const Dexie = globalThis[DexieSymbol] || (globalThis[DexieSymbol] = _Dexie);
|
||||
if (_Dexie.semVer !== Dexie.semVer) {
|
||||
throw new Error(`Two different versions of Dexie loaded in the same app: ${_Dexie.semVer} and ${Dexie.semVer}`);
|
||||
}
|
||||
const { liveQuery, mergeRanges, rangesOverlap, RangeSet, cmp, Entity,
|
||||
PropModSymbol, PropModification, replacePrefix, add, remove } = Dexie;
|
||||
export { liveQuery, mergeRanges, rangesOverlap, RangeSet, cmp, Dexie, Entity,
|
||||
PropModSymbol, PropModification, replacePrefix, add, remove };
|
||||
export default Dexie;
|
||||
@@ -1,145 +0,0 @@
|
||||
{
|
||||
"name": "dexie",
|
||||
"version": "4.0.7",
|
||||
"description": "A Minimalistic Wrapper for IndexedDB",
|
||||
"main": "dist/dexie.js",
|
||||
"module": "dist/dexie.mjs",
|
||||
"jsnext:main": "dist/dexie.mjs",
|
||||
"exports": {
|
||||
".": {
|
||||
"production": {
|
||||
"module": "./import-wrapper-prod.mjs",
|
||||
"import": "./import-wrapper-prod.mjs",
|
||||
"require": "./dist/dexie.min.js",
|
||||
"default": "./dist/dexie.min.js"
|
||||
},
|
||||
"development": {
|
||||
"module": "./import-wrapper.mjs",
|
||||
"import": "./import-wrapper.mjs",
|
||||
"require": "./dist/dexie.js",
|
||||
"default": "./dist/dexie.js"
|
||||
},
|
||||
"default": {
|
||||
"module": "./import-wrapper.mjs",
|
||||
"import": "./import-wrapper.mjs",
|
||||
"require": "./dist/dexie.js",
|
||||
"default": "./dist/dexie.js"
|
||||
}
|
||||
},
|
||||
"./package.json": "./package.json",
|
||||
"./dist/dexie.mjs": "./dist/dexie.mjs"
|
||||
},
|
||||
"typings": "dist/dexie.d.ts",
|
||||
"jspm": {
|
||||
"format": "cjs",
|
||||
"ignore": [
|
||||
"src/"
|
||||
]
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/dexie/Dexie.js.git"
|
||||
},
|
||||
"keywords": [
|
||||
"indexeddb",
|
||||
"browser",
|
||||
"database"
|
||||
],
|
||||
"author": "David Fahlander <https://github.com/dfahlander>",
|
||||
"contributors": [
|
||||
"Christopher Hunt <https://github.com/chrahunt>",
|
||||
"Nikolas Poniros <https://github.com/nponiros>",
|
||||
"Anders Ekdahl <https://github.com/andersekdahl>",
|
||||
"Yury Solovyov <https://github.com/YurySolovyov>",
|
||||
"Martin Diphoorn <https://github.com/martindiphoorn>"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/dexie/Dexie.js/issues"
|
||||
},
|
||||
"just-build": {
|
||||
"default": [
|
||||
"# Build all targets (es5, es6 and test) and minify the default es5 UMD module",
|
||||
"just-build release test"
|
||||
],
|
||||
"dexie": [
|
||||
"# Build dist/dexie.js, dist/dexie.mjs and dist/dexie.d.ts",
|
||||
"cd src",
|
||||
"tsc [--watch 'Watching for file changes']",
|
||||
"tsc --target es2020 --outdir ../tools/tmp/modern/src/",
|
||||
"rollup -c ../tools/build-configs/rollup.config.js",
|
||||
"rollup -c ../tools/build-configs/rollup.umd.config.js",
|
||||
"rollup -c ../tools/build-configs/rollup.modern.config.js",
|
||||
"node ../tools/replaceVersionAndDate.js ../dist/dexie.js",
|
||||
"node ../tools/replaceVersionAndDate.js ../dist/dexie.mjs",
|
||||
"node ../tools/replaceVersionAndDate.js ../dist/modern/dexie.mjs",
|
||||
"dts-bundle-generator --inline-declare-global --inline-declare-externals -o ../dist/dexie.d.ts public/index.d.ts",
|
||||
"node ../tools/prepend.js ../dist/dexie.d.ts ../tools/build-configs/banner.txt",
|
||||
"node ../tools/replaceVersionAndDate.js ../dist/dexie.d.ts"
|
||||
],
|
||||
"release": [
|
||||
"# Build ES5 umd module as well as the es6 module.",
|
||||
"just-build dexie",
|
||||
"node tools/replaceVersionAndDate.js dist/dexie.d.ts",
|
||||
"# Minify the default ES5 UMD module",
|
||||
"cd dist",
|
||||
"uglifyjs dexie.js -m -c negate_iife=0 -o dexie.min.js --source-map url=dexie.min.js.map",
|
||||
"# Minify modern bundle",
|
||||
"cd modern",
|
||||
"terser --comments false --compress --mangle --module --source-map url=dexie.min.mjs.map -o dexie.min.mjs -- dexie.mjs"
|
||||
],
|
||||
"dev": [
|
||||
"# Build ES5 module and the tests",
|
||||
"just-build dexie test"
|
||||
],
|
||||
"gzip": [
|
||||
"# Optionally gzip to find the size of the minified & gzipped version",
|
||||
"gzip dist/dexie.min.js -k -f -9"
|
||||
],
|
||||
"test": [
|
||||
"# Build the test suite.",
|
||||
"cd test",
|
||||
"tsc [--watch 'Watching for file changes']",
|
||||
"rollup -c ../tools/build-configs/rollup.tests.config.js"
|
||||
]
|
||||
},
|
||||
"homepage": "https://dexie.org",
|
||||
"devDependencies": {
|
||||
"@lambdatest/node-tunnel": "^4.0.7",
|
||||
"cross-env": "^7.0.3",
|
||||
"dts-bundle-generator": "^5.9.0",
|
||||
"just-build": "^0.9.24",
|
||||
"karma": "^6.1.1",
|
||||
"karma-chrome-launcher": "^3.1.0",
|
||||
"karma-firefox-launcher": "^2.1.0",
|
||||
"karma-mocha-reporter": "^2.2.5",
|
||||
"karma-qunit": "^4.1.1",
|
||||
"karma-webdriver-launcher": "^1.0.8",
|
||||
"qunit": "^2.10.0",
|
||||
"qunitjs": "^1.23.1",
|
||||
"rollup": "^2.40.0",
|
||||
"rollup-plugin-cleanup": "^3.2.1",
|
||||
"rollup-plugin-commonjs": "^10.1.0",
|
||||
"rollup-plugin-node-resolve": "^5.2.0",
|
||||
"rollup-plugin-sourcemaps": "^0.6.3",
|
||||
"rxjs": "^6.6.6",
|
||||
"safari-14-idb-fix": "^3.0.0",
|
||||
"serve-static": "^1.14.1",
|
||||
"sorted-json": "^0.2.6",
|
||||
"terser": "^5.3.1",
|
||||
"tslib": "^2.1.0",
|
||||
"typescript": "^5.3.3",
|
||||
"uglify-js": "^3.9.2"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "just-build",
|
||||
"watch": "just-build --watch",
|
||||
"clean": "rm -rf tools/tmp && rm dist/*.js && rm dist/*.map && rm dist/*.ts && rm dist/*.mjs",
|
||||
"test": "pnpm run build && pnpm run test:typings && pnpm run test:unit",
|
||||
"test:unit": "karma start test/karma.conf.js --single-run",
|
||||
"test:typings": "tsc -p test/typings-test/",
|
||||
"test:debug": "karma start test/karma.conf.js --log-level debug",
|
||||
"test:ltcloud": "cross-env LAMBDATEST=true pnpm run test:ltTunnel & sleep 10 && pnpm run test:unit; UNIT_STATUS=$?; kill $(cat tunnel.pid); exit $UNIT_STATUS",
|
||||
"test:ltTunnel": "node test/lt-local"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user