@mirakurunchan/ng-hal
v1.0.0-alpha1
Published
Navigator for Hypermedia Abstraction Language (HAL) documents in Angular
Downloads
17
Maintainers
Readme
ng-hal
A navigator for HAL documents in Angular
Usage
$ npm install --save ng-hal
Alternative, use yarn:
$ yarn add ng-hal
Import HalModule.forRoot()
to your application's module:
import { HalModule } from 'ng-hal';
@NgModule({
imports: [
HttpModule,
HalModule.forRoot()
]
})
export class AppModule {}
Inject Navigator
into components or services, then start retrieving HAL/JSON documents:
import { Navigator } from 'ng-hal';
@Injectable()
export class Foo {
constructor(
private navigator: Navigator
) {}
demo() {
this.navigator
.get('/my/hal-document.json')
.subscribe((doc: HalDocument) => console.log(doc));
}
}
Demo application
API Design Considerations
Navigator
API is almost identical to Angular'sHttp
API.follow
is a short-cut Observable operation that is derived frommergeMap
/flatMap
.
HalDocument
gives you aResource
object and the originalRequest
/Response
pair.Resource
is a normalized view of the JSON document. You can, however, obtain the unmodified JSON object.
Reading List
- HAL - Hypertext Application Language: specification
- JSON Hypertext Application Language: draft-kelly-json-hal-08
- URI Templates: RFC 6570
Version History
v0.4.2
support Angular^2.0.0 || ^4.0.0
from legacy code basev0.4.1
publishes an ES5/UMD bundle and an ES5/ES2015 version of the libraryv0.4.0
BREAKING API CHANGES, supports AoT compilation, removes uri-templates dependency, uses yarn, increases test coveragev0.3.0
tsconfig"noEmitHelpers": false
v0.2.0
renamed tong-hal
, version bumpsv0.1.0
first version on public npm registry
License
Copyright (c) 2016 David Herges
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Credits
- basti1302/halfred: resource parsing and normalization for
application/hal+json
- geraintluff/uri-templates: URI templates according to RFC6570
- Daniel Rosenwasser: for helping out on TypeScript #10463
- AngularClass/angular2-webpack-starter: build tools
- manekinekko/angular-library-starter: build tools