Skip to content

API Reference


API Reference / @dasch-ng/validators

@dasch-ng/validators ​

Collection of Angular form validators for common validation scenarios.

Installation ​

bash
npm install @dasch-ng/validators

Features ​

  • Hex Validator: Validates hexadecimal color codes and values
  • Number Validator: Enhanced number validation with range support
  • JSON, Integer, Float, Not Blank, Unique: Common checks as ValidatorFn and directive
  • Directive-based: Easy integration with Angular Reactive and Template-driven forms
  • Type-safe: Full TypeScript support with proper typings

Basic Usage ​

Hex Validator ​

typescript
import { HexValidatorDirective } from '@dasch-ng/validators';

@Component({
  selector: 'app-example',
  imports: [HexValidatorDirective, ReactiveFormsModule],
  template: `
    <input type="text" [formControl]="colorControl" hexValidator placeholder="#FF5733" />
    <div *ngIf="colorControl.errors?.['hex']">Invalid hex color code</div>
  `,
})
export class ExampleComponent {
  colorControl = new FormControl('');
}

Number Validator ​

typescript
import { NumberValidatorDirective } from '@dasch-ng/validators';

@Component({
  selector: 'app-example',
  imports: [NumberValidatorDirective, FormsModule],
  template: ` <input type="text" [(ngModel)]="value" numberValidator [min]="0" [max]="100" /> `,
})
export class ExampleComponent {
  value = '';
}

Available Validators ​

  • hexValidator - Validates hexadecimal values (with or without # prefix)
  • numberValidator - Validates numeric input with optional min/max constraints
  • nativeNumberValidator - Enhanced native number input validation
  • jsonValidator / validateJson - Validates JSON text, reports the parser message
  • integerValidator / validateInteger - Integer numbers or numeric strings
  • floatValidator / validateFloat - Finite numbers or numeric strings
  • notBlankValidator / validateNotBlank - Rejects empty or whitespace-only strings
  • uniqueValidator(existing, { caseInsensitive }) / [validateUnique] - Rejects values already in a list

API Reference ​

See the full API documentation for detailed information.

Running Tests ​

bash
nx test validators

License ​

MIT

Classes ​

Interfaces ​

Variables ​

Functions ​

Released under the MIT License.