Could you create @types for this module?

[scottge]

Could you create @types for this module so that it can be easily used in typescript?

[oott123]

+1 for type definition files, and there are some useful links for you @harttle :

http://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html

http://definitelytyped.org/guides/best-practices.html

As the author of liquidjs, you can just add a file named like index.d.ts in your package and add a field named types point to that file, without having knownledge to definitelytyped. The link provide above is a guide for you to create high-quality type definitions.

[harttle]

A index.d.ts from @oott123 has been merged and published @6.2.0, try it!
If you still got problems, any revision is welcome. I'm not closing this issue for now.

[scottge]

Excellent!!! :)

A few types are still missing:

tagToken: any
remainTokens: any
scope: any
hash: any

I also don't think 'void' is the right return type for render.. According to https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#rendering, render is supposed to return a string.

Thanks to your types, I can finally implement tag using this kind of code:

class HighlightTagImpl implements Liquid.Tag {
  parse(tagToken: any, remainTokens: any): void {
    throw new Error('Method not implemented.')
  }
  render(scope: any, hash: any): void {
    throw new Error('Method not implemented.')
  }
}

engine.registerTag('highlight', new HighlightTagImpl())

[scottge]

Update: the type definition is giving the following error.

Here is how I import it in typescript:

import Liquid, { LiquidEngine } from 'liquidjs'

Here is how I use it in my typescript code:

class MyClass {
    private engine: LiquidEngine
    public constructor() {
        this.engine = Liquid()
    }
}

Here is the error I receive:

TSError: ⨯ Unable to compile TypeScript:
error TS1192: Module '"/node_modules/liquidjs/src/index"' has no default export.

[scottge]

It turns that I MUST use import Liquid = require('liquidjs') to import the module in order for it to work. I cannot do import from.

[oott123]

Liquidjs is not a es module, so that you may HAVE to use the require form instead of regular import syntax. However, these types have some errors and I have no time to fix it. Maybe someone can take over it.

[harttle]

I cannot do import from.

Now it should work, there's an demo located at demo/typescript/index.ts. Definitions for tagToken, remainTokens, scope, hash, etc are still not available, but maybe added latter.

Let me know if you have problems with the demo.

[scottge]

Types seems broken in the latest 7.0 release? My ts project is complaining that could not find a declaration file for liquidjs.

[harttle]

Now it's fixed @7.0.1 and all methods should be typed already. Closing.