@patternplate/api
Patternplate JSON API
Last updated a year ago by marionebl .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @patternplate/api 
SYNC missed versions from official npm registry.

Documentation and development interface for component libraries

@patternplate/api

  • Framework independent
  • Bring design docs to live with real components
  • Powerful search and meta data system

This is the contributor documentation for @patternplate/cli For user docs see patternplate.github.io

About @patternplate/api

@patternplate/api provides an express middleware for use with @patternplate/client, as well as a web socket emitting data about file changes and compilation processes.

Endpoints

  • / - Web socket
  • /state.json - Document and pattern tree
  • /demo/*.html - Demo renderings

WebSocket

The web socket on / emits the following events:

  • {type: "change", "payload": {file: "string", p: conntentType: "pattern" | "doc"}"}
  • {type: "error", "payload": Error"}
  • {type: "start", "payload": {target: "node" | "web"}}
  • {type: "done", "payload": {target: "node" | "web"}}

Quick start

git clone https://github.com/patternplate/patternplate.git
cd patternplate/packages/cli
yarn
yarn start

Usage

const http = require("http");
const api = require("@patternplate/api");

(async () => {
  const server = http.createServer();

  const apiRoute = await api({
    cwd: process.cwd(),
    server
  });

  const app = express().use("/api/", apiRoute)
})();

License

Copyright by SinnerSchrader. All @patternplate packages are released under the MIT license.

Current Tags

  • 3.0.7-1                                ...           canary (2 years ago)
  • 3.2.5                                ...           latest (a year ago)
  • 3.2.14                                ...           next (a year ago)
  • 2.6.2-0                                ...           testing (2 years ago)

144 Versions

  • 3.2.14                                ...           a year ago
  • 3.2.13                                ...           a year ago
  • 3.2.12                                ...           a year ago
  • 3.2.11                                ...           a year ago
  • 3.2.10                                ...           a year ago
  • 3.2.9                                ...           a year ago
  • 3.2.8                                ...           a year ago
  • 3.2.7                                ...           a year ago
  • 3.2.5                                ...           a year ago
  • 3.2.4                                ...           a year ago
  • 3.1.1                                ...           2 years ago
  • 3.0.7-1                                ...           2 years ago
  • 3.0.7-0                                ...           2 years ago
  • 3.0.6                                ...           2 years ago
  • 3.0.4                                ...           2 years ago
  • 3.0.3                                ...           2 years ago
  • 3.0.2                                ...           2 years ago
  • 3.0.1                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 2.6.2-0                                ...           2 years ago
  • 2.6.1-0                                ...           2 years ago
  • 2.6.0-0                                ...           2 years ago
  • 2.6.0-alpha.38464754                                ...           2 years ago
  • 2.6.0-alpha.154b7b63                                ...           2 years ago
  • 3.0.0-alpha.0                                ...           2 years ago
  • 2.5.25                                ...           2 years ago
  • 2.5.21                                ...           2 years ago
  • 2.5.19                                ...           2 years ago
  • 2.5.18                                ...           2 years ago
  • 2.5.17                                ...           2 years ago
  • 2.5.16                                ...           2 years ago
  • 2.5.15                                ...           2 years ago
  • 2.5.14                                ...           2 years ago
  • 2.5.13                                ...           2 years ago
  • 2.5.10                                ...           2 years ago
  • 2.5.9                                ...           2 years ago
  • 2.5.6                                ...           2 years ago
  • 2.5.5                                ...           2 years ago
  • 2.5.2                                ...           2 years ago
  • 2.5.1                                ...           2 years ago
  • 2.4.0                                ...           2 years ago
  • 2.3.1                                ...           2 years ago
  • 2.3.0                                ...           2 years ago
  • 2.2.0                                ...           2 years ago
  • 2.1.6                                ...           2 years ago
  • 2.1.4                                ...           2 years ago
  • 2.1.3                                ...           2 years ago
  • 2.1.2                                ...           2 years ago
  • 2.1.1                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.12                                ...           2 years ago
  • 2.0.10                                ...           2 years ago
  • 2.0.9                                ...           2 years ago
  • 2.0.8                                ...           2 years ago
  • 2.0.4                                ...           2 years ago
  • 2.0.3                                ...           2 years ago
  • 2.0.2                                ...           2 years ago
  • 2.0.1                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 2.0.0-93                                ...           2 years ago
  • 2.0.0-92                                ...           2 years ago
  • 2.0.0-91                                ...           2 years ago
  • 2.0.0-90                                ...           2 years ago
  • 2.0.0-89                                ...           2 years ago
  • 2.0.0-88                                ...           2 years ago
  • 2.0.0-87                                ...           2 years ago
  • 2.0.0-86                                ...           2 years ago
  • 2.0.0-85                                ...           2 years ago
  • 2.0.0-84                                ...           2 years ago
  • 2.0.0-83                                ...           2 years ago
  • 2.0.0-82                                ...           2 years ago
  • 2.0.0-81                                ...           2 years ago
  • 2.0.0-80                                ...           2 years ago
  • 2.0.0-79                                ...           2 years ago
  • 2.0.0-78                                ...           2 years ago
  • 2.0.0-77                                ...           2 years ago
  • 2.0.0-76                                ...           2 years ago
  • 2.0.0-75                                ...           2 years ago
  • 2.0.0-74                                ...           2 years ago
  • 2.0.0-73                                ...           2 years ago
  • 2.0.0-72                                ...           2 years ago
  • 2.0.0-71                                ...           2 years ago
  • 2.0.0-70                                ...           2 years ago
  • 2.0.0-69                                ...           2 years ago
  • 2.0.0-68                                ...           2 years ago
  • 2.0.0-67                                ...           2 years ago
  • 2.0.0-66                                ...           2 years ago
  • 2.0.0-65                                ...           2 years ago
  • 2.0.0-63                                ...           2 years ago
  • 2.0.0-62                                ...           2 years ago
  • 2.0.0-61                                ...           2 years ago
  • 2.0.0-60                                ...           2 years ago
  • 2.0.0-59                                ...           2 years ago
  • 2.0.0-58                                ...           2 years ago
  • 2.0.0-57                                ...           2 years ago
  • 2.0.0-56                                ...           2 years ago
  • 2.0.0-55                                ...           2 years ago
  • 2.0.0-54                                ...           2 years ago
  • 2.0.0-53                                ...           2 years ago
  • 2.0.0-52                                ...           2 years ago
  • 2.0.0-51                                ...           2 years ago
  • 2.0.0-50                                ...           2 years ago
  • 2.0.0-49                                ...           2 years ago
  • 2.0.0-48                                ...           2 years ago
  • 2.0.0-47                                ...           2 years ago
  • 2.0.0-46                                ...           2 years ago
  • 2.0.0-45                                ...           2 years ago
  • 2.0.0-44                                ...           2 years ago
  • 2.0.0-43                                ...           2 years ago
  • 2.0.0-42                                ...           2 years ago
  • 2.0.0-41                                ...           2 years ago
  • 2.0.0-40                                ...           2 years ago
  • 2.0.0-39                                ...           2 years ago
  • 2.0.0-38                                ...           2 years ago
  • 2.0.0-y.0                                ...           2 years ago
  • 2.0.0-37                                ...           2 years ago
  • 2.0.0-36                                ...           2 years ago
  • 2.0.0-35                                ...           2 years ago
  • 2.0.0-34                                ...           2 years ago
  • 2.0.0-33                                ...           2 years ago
  • 2.0.0-32                                ...           2 years ago
  • 2.0.0-31                                ...           2 years ago
  • 2.0.0-30                                ...           2 years ago
  • 2.0.0-29                                ...           2 years ago
  • 2.0.0-28                                ...           2 years ago
  • 2.0.0-27                                ...           2 years ago
  • 2.0.0-2.0.0-26.debug.0                                ...           2 years ago
  • 2.0.0-24                                ...           2 years ago
  • 2.0.0-23                                ...           2 years ago
  • 2.0.0-22                                ...           2 years ago
  • 2.0.0-21                                ...           2 years ago
  • 2.0.0-19                                ...           2 years ago
  • 2.0.0-16                                ...           2 years ago
  • 2.0.0-14                                ...           2 years ago
  • 2.0.0-13                                ...           2 years ago
  • 2.0.0-12                                ...           2 years ago
  • 2.0.0-11                                ...           2 years ago
  • 2.0.0-9                                ...           2 years ago
  • 2.0.0-8                                ...           2 years ago
  • 2.0.0-6                                ...           2 years ago
  • 2.0.0-5                                ...           2 years ago
  • 2.0.0-4                                ...           3 years ago
  • 2.0.0-3                                ...           3 years ago
  • 2.0.0-0                                ...           3 years ago
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 1
Dev Dependencies (11)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |