salespaulo / fvi-dynamoose-utils

Freund Von Idden - Dynamoose Utils Library

fvi-dynamoose-utils

• npm run compile: Executa a limpeza dos arquivos e diretorios.
• npm run debug-test: Executa os testes unitários com o DEBUG ativo.
• npm run test: Executa os testes unitários.
• npm run debug-dev: Executa os testes unitários e espera por alterações com o DEBUG ativo.
• npm run dev: Executa os testes unitários e espera por alterçãoes.
• npm run prod: Executa o código com NODE_ENV=production.
• npm run coverage: Executa os testes unitários e retorna a cobertura dos códigos através do nyc
• npm run release: Inicia uma nova release de versão incrementando o patch, git flow release start.
• npm run release:minor: Inicia uma nova release de versão incrementando o minor, git flow release start.
• npm run release:major: Inicia uma nova release de versão incrementando o major, git flow release start.
• npm run release:finish: Finaliza a release, ou seja, realiza o git flow release finish.

FVI - Dynamoose Utilities

Projeto que disponibiliza uma biblioteca utilitária na criação de schemas e outras funcionalidades na biblioteca dynamoose ou fvi-dynamoose-repository.

Utilities

Ferramentas utilitárias para realizarmos consultas no DynamoDB ou criar um Schema no Dynamoose.

const {
    toDbLastKey,
    toLastKey,
    all,
    optionalObject,
    requiredObject,
    requiredInt,
    optionalInt,
    requiredString,
    optionalString,
    requiredEnumString,
    optionalEnumString,
    requiredArrayString,
    optionalArrayString,
    hashKeyString,
    rangeKeyString,
    globalIndexString,
} = require('fvi-dynamoose-repository/app/utils')

• .toDbLastKey(obj: Object): Recebe um Object javascript padrão e retorna um Object no formato dynamoose, ou DynamoDB que representa uma lastKey para ser enviada na próxima requisição de uma listagem paginada.
• .toLastKey: Recebe um Object no formato DynamoDB e retorna um Object javascript padrão.
• .all(model, start, limit): Realiza um Model.scan com o model passado configurando a consulta para repeitar o parêmetro start que é a última chave recebida da última consulta realizada da paginação.
• .hashKeyString(): Retorna um Object com as propriedades necessárias para a criação de um campo no modelo que seja a Dynamo.HashKey.
• .rangeKeyString(): Retorna um Object com as propriedades necessárias para a criação de um campo no modelo que seja a Dynamo.RangeKey.
• .globalIndexString(name, rangeKey, project, throughput): Retorna um Object com as propriedades necessárias para a criação de um campo no modelo que seja a Dynamo.GlobalIndexKey.
• .required...(defaultValue): Retorna um Object com as propriedades necessárias para a criação de um campo obrigatório do tipo ... com um valor default, caso seja passado um valor como parâmetro.
• .optional...(defaultValue): Retorna um Object com as propriedades necessárias para a criação de um campo não obrigatório do tipo ... com um valor default, caso seja passado um valor como parâmetro. Esta opção deve ser considerada, já que para campos no Schema opicionais no DynamoDB não precisamos informar nada, schemaless.
• .requiredEnumString: Retorna um Object com as propriedades necessárias para a criação de um campo obrigatório do tipo Dynamoose.Enum.
• .optionalEnumString: Retorna um Object com as propriedades necessárias para a criação de um campo não obrigatório do tipo Dynamoose.Enum.