npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

final-arango

v0.9.10

Published

Arango-enabling decorator for Final server framework

Downloads

5

Readme

Final-Arango

This is a decorator for Final that provides easy-to-use Arango database functions.

☢️ This is under development and the API will change.

Setup

config.js

import arango from './index'

const database = arango({
  database: 'test', // set database name. test is default
  url: 'http://root:@localhost:5829/' // database url/credentials
})

export { database }

MyComponent.js

import { database } from './config'

@database({
  collection: 'User' // collection name
  // OR
  edge: 'Likes'
})
class UserComponent extends Component {
  // do your Final stuff here
}

Usage

Properties

You can now use the following class properties on your components:

schema

A schema is an object generated by flow-runtime. Below is an example. This will change when flow-runtime is update to babel@7. There are some useful types exported by final-server (StringLengthType, CollectionType, EmailType).

const UserSchema = t.type(
  'User', t.object(
    t.property('name', t.string()),
    // ... other properties
  )
)

class UserComponent extends Component {
  schema = UserSchema
  // ...
}

uniques

This is simply an array of what schema properties should be unique.

uniques = ['email']

methods

The decorator adds these methods. You should also check the tests file for any I've forgotten to mention.

find

Accepts and arangolize object. Returns array.

findOne

Same as above, but adds limit: 1 automatically. Returns object.

findAndCount

Same as above but returns object as below:

{
  data: [Array of retults],
  meta: { count: <Integer of all results> }
}

The default limit is 25, but the count will show how many results are in the DB, not just the number returned. Useful for pagination.

save

save({ name: 'joe '})
// OR, for edge documents
save(user, post, { thisIsOptional: 'hello' })

Returns the document that was made, except for edge documents which just return and object with _key and _rev.

remove

Accepts either a document object or an id string.

Other stuff

A _createdAt key is automaticlly added on all documents, so no need to add your own.