nginstack

Module: @nginstack/engine/lib/dataset/dataSetToJson

Methods

<inner> dataSetToJson(ds [, options])

Retorna os registros do DataSet como um array de objetos no formato JSON.

Esta função cria uma string com todo o conteúdo do DataSet no formato JSON, portanto ela não deve ser utilizada em DataSets com muitos registros, não sendo recomendado o seu uso em DataSets com mais de mil registros.

O DataSet será percorrido para a leitura dos registros, portanto esta função não deve ser utilizada em DataSets que estejam em inserção ou edição, caso elas não possam ser efetivadas.

Parameters:
Name Type Argument Description
ds DataSet

DataSet com os dados que serão formatados em JSON.
options Object <optional>

Opções de conversão.

Properties
Name Type Argument Description
toLowerCase boolean <optional>

Indica se os nomes dos campos serão padronizados em caixa baixa (lower case).
onlyFilled boolean <optional>

Indica se devem ser criadas propriedades para os campos sem preenchimento no DataSet.
Returns:

Retorna os dados do DataSet em formato JSON.

Type
string
Example
const dataSetToJson = require('@nginstack/engine/lib/dataset/dataSetToJson.js');
const Classes = require('@nginstack/engine/keys/Classes');
const json = dataSetToJson(classes.getCachedDataSet(Classes.USERS));

Type Definitions

DataSet

Type: