Wondering what’s next for npm?Check out our public roadmap! »

    @ideal-postcodes/api-fixtures
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    Ideal Postcodes API Fixtures

    Static test fixtures generated from api.ideal-postcodes.co.uk

    ReleaseCoverage Status CI Try on RunKit npm version

    This library provides static HTTP API response data for api.ideal-postcodes.co.uk as JSON objects. Canned API responses are exported as Fixture objects, containing a JSON response body (body) and HTTP Status Code (httpStatus).

    Fixtures are periodically regenerated with live API requests from api.ideal-postcodes.co.uk.

    We use it internally as an initial line of testing to mock HTTP requests and stub out API client function calls.

    Features

    • Static, importable JSON response payloads generated from api.ideal-postcodes.co.uk (ideal for mock HTTP requests or stubbing API clients)
    • HTTP request definition included
    • Periodically regenerated from live API responses
    • Typescript typings
    • Detailed, low level fixture and type documentation

    Usage

    Example

    npm install @ideal-postcodes/api-fixtures
    import { postcodes } from "@ideal-postcodes/api-fixtures";
    
    // or
    // const { postcodes } = require("@ideal-postcodes/api-fixtures");
    
    console.log(postcodes.success);
    
    {
      url: "/v1/postcodes/SW1A2AA",
      httpStatus: 200,
      body: {
        "code": 2000,
        "message": "success",
        "results": [
          {
            "postcode": "SW1A 2AA",
            "postcode_inward": "2AA",
            "postcode_outward": "SW1A",
            "post_town": "LONDON",
            "dependant_locality": "",
            "double_dependant_locality": "",
            "thoroughfare": "Downing Street",
            "dependant_thoroughfare": "",
            "building_number": "10",
            "building_name": "",
            "department_name": "",
            "organisation_name": "Prime Minister & First Lord Of The Treasury",
            "udprn": 23747771,
            "umprn": "",
            "delivery_point_suffix": "1A",
            "line_1": "Prime Minister & First Lord Of The Treasury",
            "line_2": "10 Downing Street",
            "line_3": "",
            "premise": "10",
            //...etc

    Quick Reference

    Licence

    Code is MIT

    Data provided by API is for testing and integration purposes only for PAF Products

    Keywords

    none

    Install

    npm i @ideal-postcodes/api-fixtures

    DownloadsWeekly Downloads

    21

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    264 kB

    Total Files

    65

    Last publish

    Collaborators

    • avatar