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

@foyer-inc/api-sdk

v1.6.0

Published

TypeScript SDK for interacting with Foyer API services.

Downloads

12

Readme

Foyer API

npm MIT License

Additional documentation at Docs

Additional details on filter structure available at Sequelize

Listed below is example usage of the Foyer api-sdk

import { OpenAPI, PropertyService } from '@foyer-inc/api-sdk';

//usually will not need to change this but it is available for redirecting requests away from the main production api
OpenAPI.BASE = 'remote api endpoint';

//use auth token from Okta or from UserService.login
//needed to access protected endpoints
//set statically and globally
OpenAPI.TOKEN = 'token';

//use await/async  or Promise callback
const properties = await PropertyService.getProperties();

PropertyService.getProperties().then((value) => console.log(value));

//Typically used with a filter to specify which Properties to return
//The filter is also used to indicate which related models should also be returned

const filter = {
  // For more granularity, all fields on Property are able to be included as search criteria.
  where: {
    BedroomsTotal: 2
    BathroomsTotalInteger: {
      gt: 2
    }
  },
  //an array of column names to return. helpful to limit returning unnecessary information
  attributes: ["ListingKey", "StreetNumber"],
  //an array of associated models to return,
  //elements in this array can also be narrowed by including a similarly structured filter
  include: [
    { association: "Media" }
  ],
  // an integer for how many entries to return
  limit: 10,
  // an integer for how many entries to skip, useful for pagination
  offset: 10,
};

const properties = await PropertyService.getProperties(JSON.stringify(filter));
//example usage with verbosity param instead of filter object
PropertyService.getProperties(undefined, 'card').then((value) =>
  console.log(value)
);

RESO Available Foyer models comply with RESO Spec

See RESO Data Dictionary for a comprehensive look at RESO

See Reference Worksheet for Standard Relationships