wpcom-proxy-request
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    wpcom-proxy-request

    Proxied cookie-authenticated REST-API and WP-API requests to WordPress.com

    You likely want to use the high-level APIs in wpcom.js instead of using this module directly.

    This module offers access to the WordPress.com REST-API and WP-API via a proxying <iframe> pointing to a special URL that proxies API requests on the host page's behalf.

    It is intended to be used in the browser (client-side) via a bundler like browserify or webpack.

    Installation

    Install wpcom-proxy-request using npm:

    npm install wpcom-proxy-request

    Example

    // Import wpcom-proxy-request handler
    import proxy from 'wpcom-proxy-request';
    
    proxy( { path: '/me' }, function ( err, body, headers ) {
    	if ( err ) {
    		throw err;
    	}
    
    	const div = document.createElement( 'div' );
    	div.innerHTML = 'Your WordPress.com "username" is: <b>@' + res.username + '</b>';
    	document.body.appendChild( div );
    } );

    Running tests

    Compile and watch client-test application

    make watch-test-app

    Run server

    make run-test-app

    Open a tab pointing to http://calypso.localhost:3001/

    License

    MIT – Copyright Automattic 2014

    Install

    npm i wpcom-proxy-request

    DownloadsWeekly Downloads

    39

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    36.3 kB

    Total Files

    7

    Last publish

    Collaborators

    • chihsuan
    • manzoorwanijk
    • adekbadek
    • rjchow
    • andrea-sdl
    • scjr
    • spsiddarthan
    • t2dw4t
    • ehg_
    • wwa
    • sirreal
    • elazzabi
    • royho
    • obliviousharmony
    • luismulinari
    • macbre
    • mjangda
    • matticbot
    • djalmaaraujo
    • brunobasto
    • a8c
    • nickdaugherty
    • blowery
    • noahtallen
    • hanifn
    • sgomes
    • tyxla
    • rrinat
    • netsuso
    • saroshaga
    • parkcityj
    • nejclovrencic
    • sirbrillig
    • samiff
    • chriszarate
    • robersongomes
    • johngodley
    • nylen
    • timmyc
    • gwwar
    • retrofox
    • tug
    • skeltoac
    • dmsnell
    • jsnajdr