Skip to content

Latest commit

 

History

History
140 lines (106 loc) · 5.25 KB

README.md

File metadata and controls

140 lines (106 loc) · 5.25 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

filemaker-ts

A typescript wrapper for the Filemaker Data API
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Filemaker-ts is an ongoing effort to build a strongly-typed API wrapper around the Filemaker Data API. The goal of this project is to reduce development time by allowing users to define their Filemaker schema in Typescript for consistency across the entire development stack.

DISCLAIMER: This project is still in early-stage development and is subject to major changes.

(back to top)

Installation

NPM:

npm install filemaker-ts

Yarn:

yarn add filemaker-ts

(back to top)

Usage

Usage examples will be published soon! The wrapper is being created on an as-needed basis and is subject to major changes.

(back to top)

Roadmap

  • Log in to database
  • Get a single record
  • Get a range of records
  • Create a record
  • Edit a record
  • Delete a record
  • Perform a find request
  • Log out of a database
  • Duplicate a record
  • Upload container data
  • Get metadata
  • Run a script
  • Set global field values

(back to top)

Contributing

Any contributions you make are greatly appreciated!

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)