Skip to content

@sourceloop/reporting-service / Exports

@sourceloop/reporting-service

Table of contents

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Functions

Type Aliases

ChartType

Ƭ ChartType: "bar" | "line"

Defined in

services/reporting-service/src/interfaces/widget-interface.interface.ts:1

DataSource

Ƭ DataSource: string | DataSourceWithAlias | SubQueryWithAlias

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:37

DataStoreConfiguration

Ƭ DataStoreConfiguration: SequelizeDataStoreConfiguration | S3DataStoreConfiguration

Defined in

services/reporting-service/src/interfaces/data-store-config.interface.ts:4

DataTypeConversionOptions

Ƭ DataTypeConversionOptions: Object

Type declaration

Name Type
arrayWrapSingle? boolean
booleanTrueValues? string[]
dateFormat? string
isMandatory? boolean
isNullable? boolean
numberPrecision? number
strictParsing? boolean

Defined in

services/reporting-service/src/enums/data-type-conversion-options.types.ts:1

FieldExpression

Ƭ FieldExpression: string | AliasExpression | FunctionExpression | SubQueryWithAlias

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:19

JSONSupportedTypes

Ƭ JSONSupportedTypes: "string" | "number" | "boolean" | "null" | "array" | "object"

Defined in

services/reporting-service/src/interfaces/json-types.interface.ts:3

JSONValueType

Ƭ JSONValueType: string | number | boolean | null | AnyObject[] | Record<string, AnyObject>

Defined in

services/reporting-service/src/interfaces/json-types.interface.ts:10

JoinType

Ƭ JoinType: "INNER" | "LEFT" | "RIGHT" | "FULL"

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:16

NonChartType

Ƭ NonChartType: "pie" | "table"

Defined in

services/reporting-service/src/interfaces/widget-interface.interface.ts:2

Operator

Ƭ Operator: "LIKE" | "NOT LIKE" | "<>" | "<" | ">" | "<=" | ">=" | "=" | "IN" | "NOT IN" | "EXISTS" | "IS" | "IS NOT"

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:1

OrderDirection

Ƭ OrderDirection: "ASC" | "DESC"

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:15

WhereClause

Ƭ WhereClause: Object

Type declaration

Name Type
and? (WhereCondition | WhereClause)[]
or? (WhereCondition | WhereClause)[]

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:78

Functions

customTypeConversion

▸ customTypeConversion(convertType): ClassDecorator

The function CustomTypeConverterDecorator creates a decorator for a custom type converter with the specified convertType.

Parameters

Name Type Description
convertType string The convertType parameter is a string that represents the type that needs to be converted.

Returns

ClassDecorator

a decorator created by the ClassDecoratorFactory.createDecorator method. The decorator is created with the ReportingServiceComponentBindings.CUSTOM_TYPE_CONVERTER_METADATA as the first argument and an object with the convertType property set to the convertType parameter as the second argument.

Defined in

services/reporting-service/src/decorators/custom-type-converter.decorator.ts:14

handleRecordType

▸ handleRecordType(recordType): ClassDecorator

The function creates a class decorator factory that binds a record type to a reporting service event listener metadata.

Parameters

Name Type Description
recordType string The recordType parameter is a string that represents the type of record.

Returns

ClassDecorator

a decorator created by the ClassDecoratorFactory.createDecorator method.

Defined in

services/reporting-service/src/decorators/report-event-listener.decorator.ts:11