contentstack-lib v1.0.0

contentstack-lib

NPM module containing shared code for our content stack resources

RdsConnection

Class responsible for holding our SQL connection and making it available to be used in our code.

Constructor Arguments

import { RdsConnection } from '@slmdevs/contentsack-lib'

const rdsConnection: RdsConnection = new RdsConnection('sampleConnectionUrl', {
	hostUrl: 'sample.host.url',
	port: 3306,
	databaseName: 'myDB',
	username: 'admin',
	password: 'admindev1',
	sslOpts: { rejectUnauthorized: false },
	connectionOptions: { applicationName: 'mySampleApp' }
})

//....

Methods

getConnection

Public method that returns the current SQL connection to be used in our code.

//...
let connection = rdsConnection.getConnection()

ContentUtil

Static class holding utility methods to simplify the transformation of content

Methods

capitalize

Static method that takes a string and returns the capitalized version

convertCamelToSnake

Static method that takes a camelcase string and converts it to snake case.

import { ContentUtil } from '@slmdevs/contentsack-lib'

ContentUtil.capitalize('uncapitalizedName') // UncapitalizedName
ContentUtil.convertCamelToSnake('myCamelCaseString') // my_Camel_Case_String

Interfaces

Here is a list of the interfaces made available by this module

RdsConnectionOpts

Options object passed into the RdsConnection constructor

WriterArticle

Shape of the article object

WriterAuthor

Shape of the author object

WriterCategory

Shape of the category object

WriterTag

Shape of the tag object

FindArticleInput

Shape of the input object provided when querying for an article