amass/qtpromise
1
0
Fork 0
mirror of https://github.com/simonbrunel/qtpromise.git synced 2024-11-22 10:40:08 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
815dc443b9
qtpromise/docs/.vuepress/config.js

71 lines
2.5 KiB
JavaScript
Raw Normal View History

Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
module.exports = {
title: 'QtPromise',
description: 'Promises/A+ implementation for Qt/C++',
ga: 'UA-113899811-1',
head: [
['link', { rel: 'icon', href: `/favicon.png` }],
],
themeConfig: {
repo: 'simonbrunel/qtpromise',
lastUpdated: 'Last Updated',
editLinks: true,
docsDir: 'docs',
Integrate DocSearch (Algolia) https://github.com/algolia/docsearch-configs/blob/master/configs/qtpromise.json https://community.algolia.com/docsearch/
2018-09-10 18:36:31 +08:00
algolia: {
apiKey: '0e6e9cccb8c2c360a5543e28c4e31cb8',
indexName: 'qtpromise'
},
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
sidebar: [
'qtpromise/getting-started',
'qtpromise/qtconcurrent',
Add support for creating promises from Qt signals (#25) Introduce a new `QtPromise::connect()` helper that allows to create a promise resolved from a single signal and optionally, rejected by another one (from a different object or not). The promise type is determined by the type of the first signal argument (other arguments are currently ignored). A `QPromise<void>` is returned if the resolve signal doesn't provide any argument. If the rejection is emitted before the promise is resolved, the promise will be rejected with the value of the first argument (other arguments being ignored). If the rejection signal doesn't provide any argument, the promise will be rejected with `QPromiseUndefinedException` if the signal is emitted. Additionally, the promise will be automatically rejected with `QPromiseContextException` if the source object is destroyed before the promise is resolved.
2019-03-04 20:58:01 +08:00
'qtpromise/qtsignals',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
'qtpromise/thread-safety',
'qtpromise/api-reference',
{
title: 'QPromise',
children: [
'qtpromise/qpromise/constructor',
'qtpromise/qpromise/delay',
'qtpromise/qpromise/each',
'qtpromise/qpromise/fail',
'qtpromise/qpromise/filter',
'qtpromise/qpromise/finally',
'qtpromise/qpromise/isfulfilled',
'qtpromise/qpromise/ispending',
'qtpromise/qpromise/isrejected',
'qtpromise/qpromise/map',
Implement QPromise<Sequence<T>>::reduce(reducer, initialValue) Iterates over all the promise values (i.e. `Sequence<T>`) and reduces the sequence to a single value using the given `reducer` function and an optional `initialValue`. Also provide a static helper to directly reduce values (`QtPromise::reduce(values, reducer, initialValue)`).
2019-02-25 17:07:06 +08:00
'qtpromise/qpromise/reduce',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
'qtpromise/qpromise/tap',
'qtpromise/qpromise/tapfail',
'qtpromise/qpromise/then',
'qtpromise/qpromise/timeout',
'qtpromise/qpromise/wait',
'qtpromise/qpromise/reject.md',
'qtpromise/qpromise/resolve.md'
]
},
{
title: 'Helpers',
children: [
Rename qPromiseAll() helper to QtPromise::all() For consistency with other helpers, deprecate `qPromiseAll()` in favor of `QtPromise::all()`.
2019-03-06 00:37:41 +08:00
'qtpromise/helpers/all',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
'qtpromise/helpers/attempt',
Add support for creating promises from Qt signals (#25) Introduce a new `QtPromise::connect()` helper that allows to create a promise resolved from a single signal and optionally, rejected by another one (from a different object or not). The promise type is determined by the type of the first signal argument (other arguments are currently ignored). A `QPromise<void>` is returned if the resolve signal doesn't provide any argument. If the rejection is emitted before the promise is resolved, the promise will be rejected with the value of the first argument (other arguments being ignored). If the rejection signal doesn't provide any argument, the promise will be rejected with `QPromiseUndefinedException` if the signal is emitted. Additionally, the promise will be automatically rejected with `QPromiseContextException` if the source object is destroyed before the promise is resolved.
2019-03-04 20:58:01 +08:00
'qtpromise/helpers/connect',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
'qtpromise/helpers/each',
'qtpromise/helpers/filter',
'qtpromise/helpers/map',
Implement QPromise<Sequence<T>>::reduce(reducer, initialValue) Iterates over all the promise values (i.e. `Sequence<T>`) and reduces the sequence to a single value using the given `reducer` function and an optional `initialValue`. Also provide a static helper to directly reduce values (`QtPromise::reduce(values, reducer, initialValue)`).
2019-02-25 17:07:06 +08:00
'qtpromise/helpers/reduce',
Rename qPromiseAll() helper to QtPromise::all() For consistency with other helpers, deprecate `qPromiseAll()` in favor of `QtPromise::all()`.
2019-03-06 00:37:41 +08:00
'qtpromise/helpers/resolve'
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
]
Add documentation for built-in exceptions
2019-02-01 23:06:29 +08:00
},
{
title: 'Exceptions',
children: [
'qtpromise/exceptions/canceled',
Add support for creating promises from Qt signals (#25) Introduce a new `QtPromise::connect()` helper that allows to create a promise resolved from a single signal and optionally, rejected by another one (from a different object or not). The promise type is determined by the type of the first signal argument (other arguments are currently ignored). A `QPromise<void>` is returned if the resolve signal doesn't provide any argument. If the rejection is emitted before the promise is resolved, the promise will be rejected with the value of the first argument (other arguments being ignored). If the rejection signal doesn't provide any argument, the promise will be rejected with `QPromiseUndefinedException` if the signal is emitted. Additionally, the promise will be automatically rejected with `QPromiseContextException` if the source object is destroyed before the promise is resolved.
2019-03-04 20:58:01 +08:00
'qtpromise/exceptions/context',
Add documentation for built-in exceptions
2019-02-01 23:06:29 +08:00
'qtpromise/exceptions/timeout',
'qtpromise/exceptions/undefined'
]
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
}
]
}
}
Reference in New Issue Copy Permalink