ng2-hal
An HAL Navigator for Angular2
Usage
$ npm install ng2-hal
Register with Angular's dependency injection:
import { Navigator, ConversionStrategy, ConversionStrategyJson } from '../../dist';
const MY_PROVIDERS: any[] = [
new Provider(ConversionStrategy, { useFactory: () => new ConversionStrategyJson() }),
Navigator
];
Please note: you also need Angular's Http
ready for DI. It is required by Navigator
.
Navigation example:
import { Navigator } from 'ng2-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
http://spektrakel.de/ng2-hal
API Design Considerations
d.ts
are the API docs.
Please refer to the generated type definitions.
Reading List
Heads up!
This is still very much work-in-progress.
TODOs
Version History
v0.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