flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update(express-sitemap-xml): align with v1.1 (#43619)

Browse Source 
- minor changes to structure and JSDoc
- version bump to current 1.1
- mantainer added

https://github.com/feross/express-sitemap-xml#api

Tnanks!
This commit is contained in:
Piotr Błażejewicz (Peter Blazejewicz) 2020-04-11 04:43:08 +02:00 committed by GitHub
parent 18d07f6b56
commit c9f8669862
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
types/express-sitemap-xml/express-sitemap-xml-tests.ts
View File

@ -1,11 +1,11 @@
import * as express from 'express';
import express = require('express');
import expressSitemapXml = require('express-sitemap-xml');
import { buildSitemaps } from 'express-sitemap-xml';
const page2Leaf: expressSitemapXml.LeafObject = {
changeFreq: 'weekly',
lastMod: new Date(),
url: '/page2'
url: '/page2',
};
const leaves = ['/page1', page2Leaf];
@ -14,6 +14,7 @@ const getLeaves = () => leaves;
const getLeavesPromise = () => Promise.resolve(leaves);
expressSitemapXml.buildSitemaps(leaves, base).then(sitemap => typeof sitemap === 'object');
buildSitemaps(leaves, base).then(sitemap => typeof sitemap === 'object');
const sitemap1 = expressSitemapXml(getLeaves, base);
const sitemap2 = expressSitemapXml(getLeavesPromise, base);

21
types/express-sitemap-xml/index.d.ts vendored
View File

@ -1,12 +1,20 @@
// Type definitions for express-sitemap-xml 1.0
// Type definitions for express-sitemap-xml 1.1
// Project: https://github.com/feross/express-sitemap-xml
// Definitions by: Florian Keller <https://github.com/ffflorian>
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
import * as express from 'express';
import express = require('express');
declare function expressSitemapXml(getUrls: (() => (expressSitemapXml.SitemapLeaf[] | Promise<expressSitemapXml.SitemapLeaf[]>)), base: string): express.RequestHandler;
/**
* Express middleware to serve {@link https://en.wikipedia.org/wiki/Sitemaps|`sitemap.xml`} from a list of URLs
* Create a sitemap.xml middleware.
*/
declare function expressSitemapXml(
getUrls: () => expressSitemapXml.SitemapLeaf[] | Promise<expressSitemapXml.SitemapLeaf[]>,
base: string,
): express.RequestHandler;
declare namespace expressSitemapXml {
interface LeafObject {
@ -21,7 +29,12 @@ declare namespace expressSitemapXml {
[leaf: string]: string;
}
function buildSitemaps(urls: SitemapLeaf[], base: string): Promise<Sitemap>;
/**
*
* Create an object where the keys are sitemap URLs to be served by the server
* and the values are strings of sitemap XML content
*/
function buildSitemaps(urls: SitemapLeaf[], base: string): Promise<Sitemap>;
}
export = expressSitemapXml;