dfx-helper

dfx-helper

Angular Library with tons of utility tools helping in all projects.

Information

• NPM package link
• Usage
• Development
• Deployment notes
• Project website

Usage

npm install dfx-helper

If you have not already installed @angular/cdk

npm install @angular/cdk

Useful classes:

• Components
  • ABlock - Building block from ui stuff
  • AComponent
  • ADirective
• Decorator/Annotations
  • Confirmable()
  • Delay()
  • MeasureTime()
  • Once
  • RememberResult
  • RunOutesideChangeDetection
  • Throttle()
• Directives
  • hideIfOnline & hideIfOffline
  • hideIfPingSucceeds & hideIfPingFails
  • print
  • trackByPropertyName, trackById & trackByIndex
• Helper
  • ArrayHelper
  • BrowserHelper
  • ClipboradHelper
  • Converter
  • DateHelper
  • Generator
  • Logger / LoggerFactory
  • Stopwatch
  • StorageHelper
  • StringHelper
  • Thread
  • TypeHelper
  • UIHelper
• Entities
  • HasID & HasName
  • IEntity & IEntityWithName
  • AEntity & AEntityWithName
  • EntityServices
    • AEntityService
    • ASelectableEntityService
• Interceptors
  • BaseUrlInterceptor
  • LoggingInterceptor
  • PostPutJsonContentTypeInterceptor
• Pipes
  • cut
  • implode & implodeMapped
  • timespan
  • truncate
• Services
  • IsMobileService
• Strategies
  • AbstractTitleStrategy
  • DfxPreloadStrategy
• Collections
  • List
  • EntityList
  • IList

Development

Everything important in this library is located in projects/dfx-helper, that's the "real" library. (following commands still have to be executed at the root level)

Dependency installation

npm install

Building a production version

npm run helper:build

Lint

npm run helper:lint

Starting development environment (with automatic tests)

npm helper:test

Generating a coverage report

npm run helper:test:coverage

Starting the development environment (for direct use in another project)

npm run helper:watch

Development builds

Development builds are downloadable via this link.

Production builds

Tags create a release build downloadable via this link. Additionally, a versioned zip is uploaded and the package is published to npm.