Node.js - collection()

Creates a new Collection.

import { collection } from '@nitric/sdk'

const profiles = collection('profiles').for('reading', 'writing', 'deleting')

Parameters

  • Name
    name
    Required
    Required
    Type
    string
    Description

    The unique name of this Collection within the app. Subsequent calls to collection with the same name will return the same object.

Access

All Nitric resources provide access permissions you can use to specify the level of access your code needs to the resource. See here for details Access Control documentation.

Available permissions:

reading

This permission allows your code to read and query documents from the collection.

writing

This permission allows your code to write documents to the collection.

deleting

This permission allows your code to delete documents from the collection.

Examples

Create a collection

import { collection } from '@nitric/sdk'

const profiles = collection('profiles').for('reading', 'writing', 'deleting')