scrubbr package¶
Classes¶
| Class | Description |
|---|---|
| Scrubbr | |
| ScrubbrState |
Enumerations¶
| Enumeration | Description |
|---|---|
| LogLevel | The scrubbr log level. Setting the log level will enabled logging for that level and below. |
Functions¶
| Function | Description |
|---|---|
| useType(typeName, serializedData) | Override the type that's being serialized. The return value from this function should be used by custom serializers. |
Type Aliases¶
| Type Alias | Description |
|---|---|
| GenericSerializer | Serializer called for each node within the data object that is being serialized. |
| JSONSchemaDefinitions | JSON Schema object that can be passed into Scrubbr. This needs to follow the format that ts-json-schema-generator uses: * All types are defined in the root definitions block. * All references ($ref) point to definitions within the JSON object. (i.e. no external references) |
| ScrubbrOptions | Options passed to the Scrubbr constructor |
| TypeSerializer | Serializer function called for a specific TypeScript type. |