Home Reference Source
import {Collection} from 'skypager-document/src/collection.js'
public class | source

Collection

Static Method Summary

Static Public Methods
public static

create(options: {}): *

public static

mount(base: *, options: {}): *

Constructor Summary

Public Constructor
public

constructor(options: {})

Member Summary

Public Members
public get

cached: *

public get
public get
public
public get
public get
public
public get
public get

ready: *

public get

scope: *

public get

scopes: *

public get

type: *

public get

Method Summary

Public Methods
public

defineScope(scopeName: *, routePattern: *, options: *): *

public

loadFiles(files: *): *

public

runImporter(cacheDocuments: boolean): *

Static Public Methods

public static create(options: {}): * source

Params:

NameTypeAttributeDescription
options {}
  • optional
  • default: {}

Return:

*

public static mount(base: *, options: {}): * source

Params:

NameTypeAttributeDescription
base *
  • optional
options {}
  • optional
  • default: {}

Return:

*

Public Constructors

public constructor(options: {}) source

Params:

NameTypeAttributeDescription
options {}
  • optional
  • default: {}

Public Members

public get cached: * source

public get documentOptions: * source

public get documents: * source

public filesLoaded: boolean source

public get ignorePatterns: * source

public get imported: * source

public importer: * source

public get patterns: * source

public get ready: * source

public get scope: * source

public get scopes: * source

public get type: * source

public get typePatterns: * source

Public Methods

public defineScope(scopeName: *, routePattern: *, options: *): * source

Params:

NameTypeAttributeDescription
scopeName *
routePattern *
options *

Return:

*

public loadFiles(files: *): * source

Params:

NameTypeAttributeDescription
files *

Return:

*

public runImporter(cacheDocuments: boolean): * source

Params:

NameTypeAttributeDescription
cacheDocuments boolean
  • optional
  • default: true

Return:

*