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

marklogic-typescript-definitions

v0.4.2

Published

TypeScript Definition files for MarkLogic built-in functions

Downloads

50

Readme

marklogic-typescript-definitions

TypeScript definition files for MarkLogic server-side-javascript functions and types, available as npm an module.

For the node.js client definitions try the marklogic-node-typescript-definitions package

Usage

Install these files as node.js dependency using npm:

npm install marklogic-typescript-definitions --save

To use the definitions, modify your tsconfig.json file, adding the following entry to the files section:

node_modules/marklogic-typescript-definitions/ts/index.d.ts

So, for example, your tsconfig.json file might look like:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es5",
    },
    "files": [
        "./lib/myCode.ts",
        "./node_modules/marklogic-typescript-definitions/ts/index.d.ts"
    ]
}

Suggested TypeScript Editors

Below are two suggested TypeScript editors:

  • (Visual Studio Code)[https://code.visualstudio.com/] runs out of the box with TypeScript support.
  • (Atom)[https://atom.io/] also provides good support (if not better), but requires installation of the atom-typescript plugin.

Building the TypeScript definitions

The git repository (and npm package) contains the built definitions. If you'd like to re-build them, perform the following:

  • Clone this project
  • Create a folder xml/
  • Download a copy of the documentation from here: http://docs.marklogic.com/MarkLogic_8_pubs.zip
  • Extract the zip, and copy the contents of the folder pubs/raw/apidoc/ into xml/
  • Delete the files listed below
  • Run npm install
  • Run gulp (may take a few minutes)

Note: you likely want to override ml-host, ml-user, and such. It runs by default as if you typed:

gulp --ml-host=ml8-ml1 --ml-port=8000 --ml-user=admin --ml-pass=admin

XML files to delete

Before trying to build, remove the following xml files (as some of these are xquery only modules):

  • admin
  • convert
  • css
  • cpf
  • custom-dictionary
  • debug
  • dls
  • docbook
  • domains
  • ec2-2009-11-30
  • excel
  • flexrep
  • geojson
  • georss
  • geospatial
  • gml
  • hadoop
  • info
  • infodev
  • json
  • kml
  • links
  • manage* (all files beginning with 'manage')
  • mgcm
  • msword
  • package* (all files beginning with 'package')
  • pdf
  • powerpoint
  • pipelines
  • pki
  • plugin
  • Profile
  • rest
  • RESTClient
  • searchapi
  • security
  • semantics-stub
  • spell
  • thesaurus
  • tieredstorage
  • temporal-stub
  • triggers
  • views
  • work-processing-ml
  • xhtml
  • xinc
  • xpointer