npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xivapi/angular-client

v2.0.1

Published

xivapi client library (service and models) for angular applications

Downloads

84

Readme

angular-client

CircleCI npm version

Documentation

Visit https://xivapi.com/docs for documentation about the web api mapped by this client.

Further documentation for this library available on documentation website: https://xivapi.github.io/angular-client/

Installation

Simply run npm i --save @xivapi/angular-client

Quick start

Add XivapiClientModule to your AppModule imports:

@NgModule({
    declarations: [
        AppComponent,
    ],
    imports: [
        ...
        XivapiClientModule.forRoot(),        
        ...
    ],
    bootstrap: [AppComponent]
})
export class AppModule {
}

In the other modules, don't call forRoot again, just import the module itself.

Then you can simply inject the service wherever you want to use it:

@Component({
    ...
})
export class FooComponent {
    
    public items$: Observable<XivapiList<any>>;
    
    constructor(private xivapi: XivapiService){
        this.items$ = this.xivapi.getList(XivapiEndpoint.Items);
    }
}

Use with private_key (Google Cloud Function)

  • Create a google cloud function, name it as you want.
  • Insert following code (with your key):
exports.xivapiProxy = (req, res) => {
  let request = require('request');
  const apiKey = '<your api key>>';
  res.set('Access-Control-Allow-Origin', '<your allowed origins>')
     .set('Access-Control-Allow-Headers', 'Content-Type');
  const url = Buffer.from(req.query.url, 'base64').toString();
  request(
    {
      url:`${url}${url.indexOf('?') > -1 ? '&':'?'}private_key=${apiKey}`,
    }, 
    function(error, response, body) {
    let errorBody = JSON.parse(body);
	let errorMessage = errorBody.error || errorBody.message;
    if (error || errorMessage) {
      res.status(400).send(errorMessage || 'Unknown Error');
    } else {
      res.status(200).set('Content-Type', 'application/json').send(body);
    }
  });
};
  • Enable proxy mode inside the api module:
   XivapiClientModule.forRoot('<GCF trigger url>')

Example url: https://us-central1-myproject.cloudfunctions.net/xivapi-proxy

Keep in mind that you can enable it based on the current environment, simply give null as proxy url if environment isn't prod, to use "normal" mode in order to get better debugging when using dev environment.