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

wagtail-api

v1.1.5

Published

An axios wrapper to easily fetch wagtail data from it's api

Downloads

21

Readme

Wagtail API for Node.js

If you want to use a wagtail api endpoint in javascript this little module will help.

import api from 'wagtail-api';

// to fetch the content of a specific page 
var pageContent = await api.pages.$get(3);

// to fetch the content of a page based on the slug
var pageContent = await api.pages.$path("/about-us");

Find pages by slug:

In order to find pages based on the slug (and not the id) add this into your mysite/api.py file:

class CustomPagesAPIViewSet(PagesAPIViewSet):
 model = Page
 filter_backends = PagesAPIViewSet.filter_backends + [
  AbsolutePathFilter,
  RealEstateFilter,
  Scheduler,
 ]
 known_query_parameters = PagesAPIViewSet.known_query_parameters.union([
  'absolute_path',
  'region',
  'price',
  'area',
  'property',
  'rooms',
  'baths',
  'available',
 ])
 body_fields = PagesAPIViewSet.body_fields + [
  'title',
  'url',
 ]
 listing_default_fields = PagesAPIViewSet.listing_default_fields + [
  'title',
  'url',
 ]
 detail_only_fields = []

 def detail_view(self, request, pk=None, slug=None):
  param = pk
  if slug is not None:
   self.lookup_field = 'slug'
   param = slug
  try:
   return super().detail_view(request, param)
  except MultipleObjectsReturned:
   # Redirect to the listing view, filtered by the relevant slug
   # The router is registered with the `wagtailapi` namespace,
   # `pages` is our endpoint namespace and `listing` is the listing view url name.
   return redirect(
    reverse('wagtailapi:pages:listing') + f'?{self.lookup_field}={param}'
   )